読者です 読者をやめる 読者になる 読者になる

by shigemk2

当面は技術的なことしか書かない

コードのコメントについて

Coding Tips

コメントについてのメモ。

構造や内容については、その言語が読める人なら誰でも解るものである。
そもそもコードを読んでる時点で当たり前の部分はクリアしている人のはずなのだから、
「何をしているコードか」は、不要なコメントである。

あとコードを書いた日付とかもバージョン管理で殘っているから必要ない

そもそもコメントを機械は読まないので、
コメントは保守者(コードを読む人)のためにあると言える。

つまり、「なぜそのようなコードになったのか」を残すべきある。
セオリー通りではないコードは、なぜそうなっているのかが解らないと手を入れられないから。

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