BohYoh.com－C/C++ FAQ 注釈の記述方法を教えてください。

C & C++ FAQ

C++

注釈の記述方法を教えてください。

　プログラム開発者自身を含め、プログラムの読み手に理解して欲しいことがら、ドキュメントととして残すべきことなど、ソースプログラムにコメントとして記入すべきです。

　ソースプログラム内の注釈は、/*と、*/で囲んで記述します。たとえば、

/* プログラムの説明 */

と、複数の行にわたることができます。
なお、注釈を入れ子にすることはできません。すなわち、

/* /* プログラムの説明 */ */

は、2行目の*/が注釈の終端とみなされ、エラーとなります。
　この形式のコメントは、PL/I言語から採用されたものです。

C99

C++

　上記に示したものに加えて、//形式の注釈を利用できます。//から、その行の終わりまでが注釈とみなされます。　たとえば、以下のように使うことができます。

int main(void)
{
    int  height;     // 身長


    return (0);
}

　なお、//形式のコメント内では、//および/*と*/は特別な意味をもちませんので、注意が必要です。

void func(void)
{
    int  x = 100;
    int  y = x    //* ... */ 2;
            +x;
}

を考えましょう。Cでは以下のように解釈されます。

void func(void)
{
    int  x = 100;
    int  y = x / 2;
            +x;
}

一方、C99およびC++では、以下のように解釈されます。

void func(void)
{
    int  x = 100;
    int  y = x + x;
}

　//形式のコメントは、Ｃ言語の前身であるBCPL言語で使われていたものです。その簡潔さのために、復活採用されました。

■ 根拠 ■