コメント

機械はよき理解者ではない


C/C++ では、好きなところに コメント を書ける。

コメントじゃない
// これが一行コメント
コメントじゃない
/*これが複数行コメント
  ここはコメント
ここまでコメント*/
コメントじゃない
// ← は次の改行までコメントになる
/*←ここから ここまで→*/
/* 複数行コメントは入れ子にできない /*←働かない */ ここはコメントじゃない! */

コメントは、コードからは絶対に 読み取れないような情報 を書くために使う。例えば、

  • プログラムが 危なそうに見えるが問題ない理由 を書く
  • プログラムを わざわざ難解に書いた理由 を書く
  • 他からコピーしてきたプログラムの コピー元 URL を書く

という感じ。

自分のプログラムも日が経てば他人のコード と言われるくらい誰でも把握できなくなるから、わかりやすくするのは大事。

ちなみに、いくつかのサイトで書いているような 「〜をしている」系コメントは要らない よ。

そのうちプログラムだけを読んで、何をしているのかある程度分かるようにしなきゃいけないからね。