|
・コメントについて コメントはつけなくても、つけすぎてもいけないと思う。 もちろん、モノには限度があるから、当然なのですが、でも、実際はこれが分かってない人がとても多いと思います。 コメントをつけなさい、という指導が行き届いているのはいいんだけど、意味不明なコメントだったり、コードを読めばすぐに分かるようなことばっかり書いてたりする。一般のプログラマーが書いたものに限らず、公開されているソースを読んだときなんかでもこんな感じのコメントが多い様な気がするんです。 そこで、私流コメントの極意。 コメントはそのコードブロックを代表する言葉１行だけ。 それでも読めるコードを書くこと。 私も過去はいろんなコメントの書き方をしてましたよ。各行ごとにコードの後ろのカラムに、その行の意味を日本語にしたコメントを書いたりしてました。その当時は、コメントは人間向けのプログラミング言語で、それをコードに翻訳するのがプログラマの作業だと思ってたからです。いや、実は実際は、その当時のプログラミング言語は非常に表現能力が乏しくて、そうでもしなければ、コードの意図を読み取るのが困難だったからという理由もあったのです。なにせ、変数名が８文字までとかいうものもめずらしくなかったんです。 しかし、いまは違います。うまく書けば、コード自身に非常に多くの、人間向けの表現を書き込むことができます。 コメントが大量に必要に感じるコードになってた場合、そのコード群にはなにがしかの問題が含まれているかもしれませんよ。 |
