コメント [雑談]
前回に引き続きコメントのお話。
私は基本的にコードにコメントを付けない人。コーディング規約等で 「メソッドには XML ドキュメントを付ける」という縛りがなければ、きっと一言も書かないんじゃないかと思う。
逆に、ステートメントごとにコメントつける主義の人もいないことはない。「自分とは話が合わなそうだなぁ」とコードを見るたび(レビュー等で見せられることがあるから)に思う。
割りと多いのが、(if とか、for とかの)ブロックごとにコメントを付けていくタイプ。
Readable Code ではないけど、コードを読むより正確に処理(考え方?)を記述しているコメントであれば良いけど、、、コメントに目を奪われないようにしなけりゃならないこともある。
コードレビュー。
コードレビューでコメント信じてしまうと、殆どレビューにならない。コメントがメンテナンスされていないなんて言うのは普通にあるし、理想的なコメントを書いている割にコードがグダグダなんてのも山ほど出てくる。
私はレビューが始まるとすぐに(ホワイトボードの)マーカー借りて、印刷されたコードのコメントを塗りつぶすことから始めるようにしている。大量のコメントに埋もれたほんのわずかなコードがバグだらけだったりすると、レビューするほうの集中力も一気に霧散してしまうと思うのは私だけ?
これだ!! というような、コメントの付け方っていうのは無いのだろうか。今のところ「どんなコメント書いても実行コードには影響しない」という考えは揺らいでいない。
コメント 0