僕は右へ行く

適当に書くよ!

プログラムのコメントの書き方でプロジェクトのレベルが分かります

こんなことを言われたことがあります。

「書いているコード、一行一行にコメントしていって」

( ゚д゚)←そのときのリアクション。
一応、理由を聞いてみたら、

「新人が入ってきたときに読めないって言われるから。自分も読めないし」

(;゚ Д゚)
で、実際にそのときにあったコード見てみたら

// i に1を足す
i = i + 1;

(イメージです)
みたいな一目で分かることまで書いてあって、それは明らかに過剰作業では?、と思いました。


プログラムのコメントに『何をしているコードか』を書いても無意味なので、代わりに『なぜそのようなコードになったのか』を書くようにしよう - じゃがめブログ


そんなレベルでなくて、その言語の構文をコメントで表現したりしているのです。
つまりプロジェクトメンバーの一番低い人に合わせたコーディングになっていて、それに合わせてコメントも書いていたと。


確かに無駄に変な書き方をすべきでないのは当然ですが、「何をやっているか分からないから」という理由で、コメントを余計に(しかも肝心の「なぜそうしたのか」は書かれていないというおまけつきで)無駄に書かせるのだけは本当に意味不明だなーと思ったのでした。


あと、絶対日本語で書け、とも言われましたねー。
理由はもちろん「英語が読めない人もいるから」。