品質におけるコメントの役割。あるいは、レビューとコメント - きしだのHatena

昨日のエントリでも書いたきょんくんとの会話なんだけど、なんとなく、コメントとテストは同じように扱えるんではないかという認識のもとで話がすすんでた。もちろん、コメント書けばテスト書かなくていいとかそういうのではなくて。 テストは、書きやすい対象と書きにくい対象がある。関数的に計算を行うコードの場合はテストが書きやすい。一方で、関数的ではなく副作用のあるコードはテストが書きにくい。データベースを扱ったり通信したりUIがあったり。 そして、そのようなテストを書きにくいときに、コメントはテストのように品質のために使えるんではないか。 で、問題は、どのように品質のために使うかということなんだけど、コードレビューのときの指針として使えばいいんじゃないかなと思った。 コードレビューのとき、コードだけを見ていると、名前付けとかコードの順番とか条件文の使い方とか、体裁的なものだけのレビューになりがち。そこで

[nkazuki]

うーん、レビューのための情報はレビューシステムなりコミットログなりに書いて欲しい。細かすぎるコメントはやがて実装と乖離して負債になる

[nrtkbb]

読んだ

[yohshiy]

プロジェクト管理ツールみたいなソースと関連付けできるツールとかを使うべきだと思う。前のコードや履歴コメントを延々残している人に「バージョン管理システム使おう」というのと同じ。

[teracy_junk]

『で、やっぱり、きょんくんはテストコードにはコメントをたくさん書く、ということを言ってた。そうすることで、セルフレビューができるということかもしれない』

[tagomoris]

“こういう場合に、今日から試してみようということができるので、今の環境はとてもよい。”

[yukung]

"品質"が何を指すかにもよるけど、あえて設計という意味で design タグ付けとく

[embedded]

なるほど。いいこと聞いた。

[raydive]

自分の経験からすると納得できるなぁ。