プログラムとコメント

腕に自信のあるプログラマーは、最近入社した新人のプログラマーに言いました。
「プログラムにコメントは必要ない。読んで理解できるプログラムを書くべきだ」
既存プロジェクトのスパゲッティコードで頭を抱えているプログラマーが、彼の言葉を聞いて反論しました。
「いいや、コメントは必要だ。たとえ間違ったコメントでも、無いよりましだ。」
新人プログラマーは、言い争いをする二人の意見に頭を悩ませました。

さて、あなたならどちらの言い分を支持しますか？
僕は後者です。僕はプログラムにはコメントを書け派です。
以前まではずっと前者でしたが、今は後者です。

というのも、これまでに色々なコードを見てきましたが、読みやすいコードを書く人は、だいたいコメントも簡潔でわかりやすい傾向があります。逆にひどいコードを書く人はコメントもよくわからない。もちろん例外もあります。

考えてみればあたりまえのことです。読みやすいコードを書けるというのは、それだけ内容を整理できているということですから。
逆になにをやっているか理解に苦しむコードでも、コメントがあれば「本当にやりたかったこと」が伝わってくることもあります。

そんな経験もあって、今ではないよりはあったほうがいいのかな、と最近思うようになりました。
　やっぱりコードはマシンだけでなく、人も読むものですからね。コメントがあったほうが楽になるケースのほうが多いです。もちろんコメントのせいではまることもあります。でも、トータルだと助かることのほうが多いような気がします。

ただし、ここでは以下のような例をコメントとはみなしてません。

 
 // テストオブジェクトを実体化する
 Test test = new Test():
 

「実体化する」キリッ

こういったコメントを見るときがありますが、誰のために書いてるのでしょうか？
コードが一行増えるので、仕事した感が芽生えるのでしょうか。
でも、こういうのはコメントとは言いません。

落書きですから!!

残念!!

この記事がお役にたちましたらシェアをお願いします

Tweet