コメントの書き方

コーディング規約スレより。

329 ：319：04/04/11 17:43
ちょっと言い方がまずかった。

i = 1 // i に 1 を代入する
みたいなのが問題外なのはもちろんだが、
そうでないものでもコードのやっていることを要約してコメントとして表している以上、
コメントがコードの繰り返しであることにはかわりはない。

もちろん、複雑な処理には適切なコメントをつけたほうが理解に役立つが、
コメントをつけずに済むのならそれに越したことはないってことを言いたかった。

334 ：デフォルトの名無しさん ：04/04/12 03:07
>コードのやっていることを要約してコメントとして表し
違う
やっていること(How)をコメントするだけなら意味が無いと言っている

なぜ(why)とか何の目的があって(what)を書け

335 ：デフォルトの名無しさん ：04/04/12 04:00
>>334
そうそう。why/what書かない奴多いんだよね。
それこそがコメントとして一番書いておいて欲しいところなのに。
仕様書にちゃんと明記してあるならいいけど、why/whatコメント
書かない奴はまず仕様書にも書いてないし。

で、後を引き継いだ奴が「なんでこんな処理が必要なんだ？」と
悩んだり、新規で作った部分でその処理が抜けてて「以前対策
したじゃないか」なんて責められたりする。
そんなんどっかに書いといてくれなきゃ分からんがな…

>>335
禿同