[jfriends] Re: コメント

[Shin <shin@xxxxxxxxxx>]

何か書こうと思ったんですが、書くことが無いことに気づきました..
In article <19991013131640.540e00d3.31745@xxxxxxxxxx>
前橋　和弥 wrote:
>高橋さん:
>> コーディング基準を設けてないプロジェクトはよく見かけます。担当者まかせ
>> なので、けっこうとんでもないです。保守に苦しむ先輩の姿を見て（愚痴を聞
>> きながら）育ったのでこの辺りはけっこう気になります。
>> 多すぎるコメントがつけられたコードというのはまだ見たことはないです。
>> コードと違うコメントというのは見たことあります。これはコメントがない
>> より始末に終えない・・・・
>
>1行程度のコメントに限って言えば、8割が無用のコメントのような
>気がします。
>
>int userId;  // ユーザID
>
>みたいな(冗談みたいだけど、よく見るぞ)

// 20回ループ
for (int i = 0; i < 20; i++) {

みたいな

あ、でも私の場合、日本語の方が目立って見えるので
>int userId;  // ユーザID
でもないよりましかもしれません.
# それを書く手間を他に回せってのも確かですが.
もう一言、
// 〜するために使用するユーザID
ならいいんですよねえ.

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

コメントを短くしようとして意味不明な文になっているものも多いですね.

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

私の一番腹が立ったのは、
/*** 1997/mm/nn rel.xx だれそれ add start **/
	:
/*** 1997/mm/nn rel.xx だれそれ add end **/
ってやつでした.
あんた問い合わせればなぜ追加したか教えてくれるの?って感じ.

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

JavaDocに関して言えば、@xxxxxxxxxx等のタグを自動生成してほしいですね.
その用法部分だけ書けばすむように.(もちろんthrows等も)
この辺もIDE付属エディタならサポートしていそうな気はしますけど.

# 「そのコメントは意味がありません」って警告してくれるツール無いかな
# あ?

──────────────────
きのしたしん
mailto:shinq@xxxxxxxxxx
http://village.infoweb.ne.jp/~shinq/
──────────────────