ソースコードを直訳したようなコメントは書くべき?
面白いtogetterがありました。
直訳したようなコメントは書くべきか?
私は書くべきではないと思います。
学生時代は先生から「コメントは書くように」という指導を受けていました。
しかし、実際に仕事にでてみると、先輩社員から「そもそもコメントが無ければ解読できないソースコードはおかしい、見ただけでどんな処理をしているかわかるプログラムを書くようにしなさい」
こう指導されました。
たしかに、コメントだらけのソースコードって非常に可読性が悪いですよね。例えば
// 速度
int velocity = 0;
// 速度を3プラスします
velocity += 3;
別にコメントが無くても、変数名を見れば意味はわかりますよね。
学生時代はわかりやすいと思ってコメントは積極的に残していましたが、今は各クラスやメソッドの上にjavadocを書くだけになりました。