書き物

技術とか作った物の話とか愚痴文句感想など

コメントの付け方

コードを読みやすくするためにコメントを付けることは重要ですが、そのコメントを付けるコツのようなものがあるようです。「コメントを付ける」と決意したなら、徹底的に付けなければと思ってしまう不器用な僕としては、1つの指針になって助かります。


コツといいましても、たった一つのシンプルなものです。

  • コードを読めば分かることは書かないで、「何をしているか」を書く。

とのこと。

言われてみればそうでした。少ない文章で多くの情報を持たせるためには、コードを読んで分かる部分は書かない方が良いです。その代わり、「この部分ではこのような処理を行っている」、「こういうことをしようとしている」といった、目的を書けばよかったんですねぇ。

var i = 0;    // iを定義
i = i + 3;    // iに3を足す

なんて書く必要は無いということで、もう少しザッとコメントを付けられるように意識しようと思います。