WebDBPress Vol.56 コーディングの基礎知識 その2

2. 適切な名前をつけ、不要なコメントはつけない
変数や関数に名前をつけるということは、その対象を説明することだ。
つまりその説明がおかしかったら、コードを読む人はコードを書いた人が何をしたいのかよく分からない
のである。変数や関数のネーミングは正確にする。何をしたいのかよく分からないなら、
その変数や関数の働きをもう一度考える必要がある。
ネーミングについては、この他にもスコープに従うこと、言語や会社のコーディング規約に従うことは
重要であると言える。
スコープが広ければ広いほど、変数名、関数名は長くしたほうがよい。
また、キャメルケースについても考える必要がある。

3.不要なコメントについて
おかしなコメントはノイズになり、メンテナンスがしにくくなる。
不要なコメントとは、

• 変数の意味を記述するコメント(コードを読め)
• 処理をトレースするコメント(コードを読め)
• 修正日や内容を記録するコメント(バージョン管理システムとかがやってくれるから無駄)
• コードのコメントアウト(メンテナンスしにくい)

また、コメントは言いわけであってはならない。

そして、理想となるコメントについてだが、
本当に良いコードは、そもそもコメントが必要ない

ということ。コメントするまえに、コメントが不要なコードを考える必要がある。

WEB+DB PRESS Vol.56