C言語入門：コメントの書き方
C言語に限らず、コメントを書くことはプログラミングの非常に重要な要素です。 ここでは、C言語でのコメントの書き方を説明したいと思います。
コメントはソースコード内に記述してある注釈のようなものです。 コメントはソースコードを読む人に「ここはこんな事していますよ」ということを知らせてくれます。 コメントはプログラムの実行には全く関係ありません。 「じゃあ何で書く必要があるのか？」と思うかも知れません。
コメントは他人のために書くものというイメージがあるかもしれませんが、まずC言語を入門される方は他人にソースコードを読ませるという事は少ないと思います。 では、誰のために書くかというと明後日の自分のためです。 コードを書いてからある程度時間が経つとコードを書いていたときの記憶が薄れてきます。 結果として数ヶ月前の自分が書いたコードは、読み返すときには他人が書いたものとあまり違わなくなってしまっているぐらい記憶がなくなっているときがあります。 要所要所にコメントを書く癖をつけておくと過去の自分をほめてあげたくなることがあるでしょう。
他人にソースコードを読んでもらう可能性がある場合にはコメントをふんだんに入れるようにしましょう。 その方が親切ですし、仕事ではコメントを書かない人は嫌われてしまうかもしれません。
サンプル１
C言語では、「/*」から始まって「*/」で終わるまでの間の部分はコメントとして扱われます。 以下のサンプルはコメントを書いた例です。
#include <stdio.h>
/* コメントサンプル */
int
main()
{
/* hello world と printfして終わります */
printf("hello world\n");
return 0;
}
上記例を実行すると「hello world」と表示されてプログラムが終了します。 /* */で囲まれたコメント部分はプログラムの実行には全く影響を与えません。 単にプログラムを読む人に情報を伝えるだけです。
サンプル２
次の例では、if文の意味を書いています。
#include <stdio.h>
int
main()
{
int i = 1;
if (i == 6000) {
/* この if 文には絶対に入りません */
printf("i == 6000");
}
return 0;
}
上記例のようにプログラムに何か期待する動きがあるのであればコメントとして書くとわかりやすくなります。
サンプル３
コメントは複数行にわたって書くことも可能です。
#include <stdio.h>
/*
ああああああ
こめんと
コメント
コメントだよーーーん
*/
int
main()
{
/*
* ちょっと整形されたコメント。
* 多少飾りつけをしてみました。
*/
/* このサンプルは何もしないでreturnします */
return 0;
}
最後に
とりあえず簡単にコメントの書き方を説明してみました。 色々プログラムを書いていくと段々コメントの書き方も慣れてくると思うので、たくさん数をこなして慣れてください。
次：関数
おまけ
