[jfriends] コメント

[前橋 和弥<PXU00211@xxxxxxxxxx>]

前橋＠コメント嫌い です。時間がないのでちょっとだけ。

# ちょっと極論ですが...

高橋さん:
> コーディング基準を設けてないプロジェクトはよく見かけます。担当者まかせ
> なので、けっこうとんでもないです。保守に苦しむ先輩の姿を見て（愚痴を聞
> きながら）育ったのでこの辺りはけっこう気になります。
> 多すぎるコメントがつけられたコードというのはまだ見たことはないです。
> コードと違うコメントというのは見たことあります。これはコメントがない
> より始末に終えない・・・・

1行程度のコメントに限って言えば、8割が無用のコメントのような
気がします。

int userId;  // ユーザID

みたいな(冗談みたいだけど、よく見るぞ)

特にJavaでは、変数名・メソッド名の命名で、長い名前を使うことに
抵抗がないので、この手のコメントはホントにただの無駄です。

そして、残りの2割のうち80%は、意味が曖昧すぎて役に立たないか、
間違ってるかのどっちかです。

文章形式のコメントなら、見るべきものもあるんですが。

さらに酷いのが、定形形式のドキュメントで、これはもう
本当に紙屑です。必要なものを見つけるまでがひと苦労、
やっと発掘しても、現状と違ってて役に立たないのです。

こういうのを生産するのにどれだけの工数を費やしたかと
思うと、暗澹たる気持ちになります。

これも、文章形式のドキュメントなら、見るべきものもあると思います。

要するに、プログラミング言語レベルよりもはるかに上流に
位置するレベルのことなら、(コーディング中にかけないので)
コメントやドキュメントで補う必要があるでしょうが、
コーディングレベルのことなら、コーディングそのもので
表明すべきである(コンパイラのチェックも入るし)、
ということです。

それができないようなら、言語の方がまだ未完成なんでしょう。

そういう意味で、javadocやPythonのように、(プログラム中に
どうしても書けないものを，できるだけコンパイラに近いところ
に取り込もうとする試みは、とても重要なことだと思うのです。

                                               de 前橋