コメントに書く内容について

IDコールされるとビクッとしてしまいます。警察官を見かけると、何も悪い事していないのにソワソワしてしまうみたいに。


それはともかく。


コードコメントに書くべきは「意図」の記事に対してブクマコメントしたら、スターでコメント貰ったり、idコールされたりしたので、意見とか考えとかを書いてみようかと思います。

id:r-west さんの云われるような、

原則的にコメント書いたら負け(コードが糞)

とまでは思っていません。


コードはそれ程流暢に処理内容やその意図を語ってくれません。語れるはずもありません。変数や函数の命名をどうにかしたところで限界はありますし、プログラミング言語の文法は人が意図を組みとれるようにはできていません。


業務アプリを作っていた時はまだ何とかなりましたが、コンシューマゲームの開発をするようになってからは、トリッキーなコードを書く事が結構増えた(場合によってはインラインアセンブラも書きますし、基本的に速度優先で記述します)ので、どうしてそのように記述したのかを明記しておかないと、後でなんでそうなっているのかがわからなくなります。特に人のコードを弄る時には(自分ならまだなんとか思い出そうとすれば思い出せる事もあります。無理な時も多々ありますが)。


僕は、コメントはid:Nagise さんのおっしゃる通り、意図を書き記すべきだと思っています。ただ、僕が直面したように、コードとコメントの齟齬が発生する場合もあります。故に僕は、日付と意図を書いて、その後、そこをさらに修正する時は、そのコメントの下に(つまり以前のコメントを消す事なく)新たに日付と意図をコメントとして記述するようにしています。


とはいえ、切羽詰まっている時はコメントを書いている余裕なんてないので、そういう時のコードを直すときにどうしたもんかと……。