C++でのコメントの使用方法と例

1. 1行コメント: // を使って、1行コメントを追加することができます。以下は例です。

   // この行はコメントです。このコードは何らかの処理を行います。

2. 複数行コメント: / と / を使って、複数行にわたるコメントを追加することができます。以下は例です。

   /*
   この部分はコメントです。
   ここに複数行の説明や文書化を追加できます。
   このコードは何らかの処理を行います。
   */

3. コード内のコメント: コードの特定の行やブロックに対してコメントを追加することもできます。これにより、コードの意図や目的を他の開発者に伝えることができます。以下は例です。

   int x = 5; // 変数xに値5を代入します
   /*
   以下はループ処理の例です。
   forループを使用して、10回繰り返します。
   */
   for (int i = 0; i < 10; i++) {
      // 何らかの処理を行います
   }

/
* 関数の説明
* @param[in] param1 パラメータ1の説明
* @param[in] param2 パラメータ2の説明
* @return 戻り値の説明
*/
int myFunction(int param1, int param2) {
   // 関数の処理
}

コメントは、コードの可読性や保守性を向上させるために重要です。適切なコメントを追加することで、自分や他の開発者がコードを理解しやすくなります。コメントを活用して、コードの意図や目的を明確に伝えるようにしましょう。