前回のあらすじ

コメントでメモを取る

プログラミングの重要な機能としてコメントがあります。コメントした部分はプログラムとして実行されません。

コメントを書くのはプログラマになるならば非常に重要な基礎教養とも言えます。ここではコメントの心得については差し控えますが、C言語にはコメントを書く機能があります。

まずは大筋としてのコメントを見てみましょう。

/**
* プログラムの開始地点
* @return exit code
* @note main関数は引数がない(void)と任意のコマンドライン引数を取る
*/
int main()
{
    // 何もしない
    return 0;     // OSに正常終了を通知する
}

行コメント

行コメントとは、//で始まるコメントです。

// 行コメント
return 0;    // 行コメント

このように、行の頭に行コメントを書く方法と、プログラム行の終わりにコメントを書く方法があります。

複数行のコメント

長いコメント、何か目立たせたいコメントなどは複数行のコメントを使います。行コメントは、/*と*/の間で囲った部分が問答無用でコメントになります。

/******************************************************************************

                            Online C Compiler.
                Code, Compile, Run and Debug C program online.
Write your code in this editor and press "Run" button to compile and execute it.

*******************************************************************************/

このコメントとかパッと見てきれいですね。頭の部分/*とお尻の部分*/で挟まっている間はコメントです。なので、このコードは全文がコメントになります。

この例はかなり大げさですが、実用的な側面としてプログラムの単位ごとに目立たせる目的で複数行コメントを書きます。

    /**
     * とても難しい処理
     **/
    printf("Hello, world");

さらに実用性を求めるとDoxygenというプログラムを使って、特殊なコメントを書いた部分を抽出して自動的に仕様書（のようなもの）を作ることができます。

興味があればぜひ参照してみてください。

おわりに

コメントを書く方法について学習しました。プログラムと関係ないように見えますが、コメントはプログラミング言語の中で比較的重要なポジションにあります。

コメントがないとなぜそのコードを書いたのかわからなかったりするので、最初のうちはたくさんコメントを残しましょう。復習になります。