コメント考 [プログラミング]
http://nakagami.blog.so-net.ne.jp/2008-04-22 の続き
元来コメントは少ないほうだと思っているが、「本当は、コメント入れたほうが他の人にわかりやすいんだよなぁ」と思っていた。ことあるごとに「コメントは多いほど良い」と言われてきた刷り込みか?
しかし、よくよく考えてみたらプログラムの処理をもっとも正確に表現しているのはプログラムソースなわけで、そこに似て非なる自然言語で記述したコメントを書いても紛らわしいだけだよな。うんうん。
例えば、僕がコメントのたくさん入ったソースを読む必要があったとして、コメントを読んで「ふむふむ、そういうことをやってるのか」と参考になる場合はあまりない。むしろ、紛らわしいコメントに騙されないように、コメントはあまり読まないようにしてる(仕様書や設計書も同じ)
確かに、暗号や圧縮といった理論となる数式が一見してプログラムでは判らないものもあり、そういう分野ではコメントが助かるが、僕は研究者ではないので、仕事で読むソースで基礎理論が難解でコメントがないとわからないってことはほとんどない。
プログラムを見ただけでは、何やってるかわからない人がコメントを読んで何か判った気になって修正されるのはかえって良くないんじゃなかろうか。
「うぁ、コメントがぜんぜんない」
と言われたときに、
「ソースが読めないんだったら修正する資格なし」と言える世の中・・・にはならないだろうなぁ。
元来コメントは少ないほうだと思っているが、「本当は、コメント入れたほうが他の人にわかりやすいんだよなぁ」と思っていた。ことあるごとに「コメントは多いほど良い」と言われてきた刷り込みか?
しかし、よくよく考えてみたらプログラムの処理をもっとも正確に表現しているのはプログラムソースなわけで、そこに似て非なる自然言語で記述したコメントを書いても紛らわしいだけだよな。うんうん。
例えば、僕がコメントのたくさん入ったソースを読む必要があったとして、コメントを読んで「ふむふむ、そういうことをやってるのか」と参考になる場合はあまりない。むしろ、紛らわしいコメントに騙されないように、コメントはあまり読まないようにしてる(仕様書や設計書も同じ)
確かに、暗号や圧縮といった理論となる数式が一見してプログラムでは判らないものもあり、そういう分野ではコメントが助かるが、僕は研究者ではないので、仕事で読むソースで基礎理論が難解でコメントがないとわからないってことはほとんどない。
プログラムを見ただけでは、何やってるかわからない人がコメントを読んで何か判った気になって修正されるのはかえって良くないんじゃなかろうか。
「うぁ、コメントがぜんぜんない」
と言われたときに、
「ソースが読めないんだったら修正する資格なし」と言える世の中・・・にはならないだろうなぁ。
2008-05-01 22:34
nice!(0)
コメント(0)
トラックバック(0)
コメント 0