必要なコメントは必ず書こう


だって必要なんだから。


コメントは、コードではないというところが最大の欠点。
コードを書き換えても自動的に書き換わってくれるわけでないので、別途メンテナンスしてやらなければならない。
これを怠ると、コードとコメントが乖離してしまって、あとから読む人が間違って理解する危険がある。
だから、不要なコメントは、ただ不要というそれだけの理由で、書いてはならない。


一方で、コメントは自然言語が使えるわけで、コードで表現しきれないプログラマの意図を表すことができる。
簡単な例を挙げると、switchのcaseに、breakが無い場合。
書き忘れなのか、わざとなのか分からない。
ここに「breakしない」と書いておくだけで、ミスでないことが分かる。


必要なコメントは、手を抜くことなく書こう。文書化されておらず、コードで表現し切れていないことは、すべて書こう。長くなってもかまわない。
そして、きちんとメンテナンスしよう。