コメント

コメントはある種のコード内ドキュメントとしての機能を持ちます。 プログラム内に挿入されたとき、それらは実質的にコンパイラによって無視されます。 それらはソースコードを読む人間によって注釈として使用されることだけが意図されています。

構文

すべてのコメントは、翻訳フェーズ3で、各コメントが1個のホワイトスペース文字で置き換えられることによって、プログラムから除去されます。

C スタイル

C スタイルのコメントは、通常、大きなテキストブロックや小さなコード片をコメント化を書くために使用されますが、単一行をコメント化するために使用することもできます。 C テキストをスタイルのコメントとして挿入するには、単純に /* と */ でそのテキストを囲みます。 C スタイルのコメントは /* と */ の間のすべての内容を無視するようコンパイラに伝えます。 C 標準の一部ではありませんが、ドキュメントブロックを示すために /** と */ がしばしば使用されます。 2つめのアスタリスクは単純にコメントの一部として扱われるので、これは合法です。

文字定数内、文字列リテラル内、またはコメント内を除き、文字 /* はコメントを導入します。 そのようなコメントの内容は、マルチバイト文字を識別するためおよびコメントを終了する文字 */ を見付けるためにのみ調べられます。 C スタイルのコメントはネストすることができません。

//  y = f(x);   // 関数を呼びます。

//  y = f(x);   /* 関数を呼びます。 */

/*
    y = f(x);   // 関数を呼びます。
    z = g(x);
*/

ノート

コメントはプリプロセッサステージより前に削除されるため、コメントを形成するためにマクロを使用することはできず、終了していない C スタイルのコメントが #include されたファイルから溢れ出ることはありません。

/* コメントを形成するためにマクロを使用する試み。 */
/* しかし、文字「//」は空白に置き換えられます。 */
#ifndef DEBUG
    #define PRINTF //
#else
    #define PRINTF printf
#endif
...  
PRINTF("Error in file %s at line %i\n", __FILE__, __LINE__);

コメントアウト以外に、ソースコードを除外するために使用される仕組みには、以下のようなものがあります。

#if 0
    puts("this will not be compiled");
    /* C スタイルのコメントと衝突しません。 */
    // C++ スタイルのコメントと衝突しません。
#endif

また、以下のようなものもあります。

if(0) {
    puts("this will be compiled but not be executed");
    /* C スタイルのコメントと衝突しません。 */
    // C++ スタイルのコメントと衝突しません。
}

C99 における // コメントの導入は、一部の稀な状況において、破壊的変更でした。

a = b //*除数:*/ c
+ d; /* C89 では a = b / c + d; とコンパイルされます。
        C99 では a = b + d; とコンパイルされます。 */

例

#include <stdio.h>
/*
C スタイルのコメントは
複数の行を含むことができます。
*/

/* あるいは、1行だけにもできます。 */

// C++ スタイルのコメントは1行をコメント化できます。

// あるいは、複数個を並べて
// 使うこともできます。

int main(void)
{
  // 以下のコードは実行されません。
  // puts("Hello");

  // 以下のコードは実行されます。
  puts("World");
}

World

参考文献