[与太] コメントは必要か?

2010年11月17日

 ネタ元>http://d.hatena.ne.jp/gallu/20101116/p1

 コメントは必要です。議論の余地がありません。
 その上で、仮にコメントがなくても理解できるコードを書くことも必要です。こちらも議論の余地がありません。

 それでは、コメントは嘘になりやすいから、書かない方が(少ない方が)よいのかというとこれも否です。

 嘘のコメントならないほうが良いのか?これも否です。。嘘でもないよりあった方が良い。なぜなら、仮に嘘でも、そのような意図があったかどうかが分かるから。仮にそれがただ他からコピペして修正し損なっているものでも、「その事実」が分かるだけで対処の方針が違ったりします。

 コメントは全体の20%以下が望ましいという言説もあるようですが、128KB程度のオンメモリで動くインタプリタ型言語のコメントじゃあるまいに、昨今の環境では折角ほぼ無限のコメントが書けるんだからガンガン書けばいいと思う。

 コメントがなくてもいいと言う人は、よほど良いコードしか触れていないか、あるいは、自ら他人のコードをメンテする必要がない人なんじゃないかと思う。

 そもそも多くの場合、コメントがない、或いは腐れている時点で、コードがどのような品質であるか想像に難くない。

 指針をひとつ掲げるとするなら、コメントは長く、コードは短く。そしてコードの邪魔にならない様にコメントを書く。といったところではないかと思う。もっとも長くとは言っても、要領よく簡潔に書くことができれば、その方がより望ましいのはコメントに限らず当然のことですが。






カテゴリー: IT / テクノロジー, 与太話

Follow comments via the RSS Feed | Leave a comment | Trackback URL

コメントを投稿する

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)


«   »
 
Powered by Wordpress and MySQL. Theme by Shlomi Noach, openark.org