So-net無料ブログ作成

コードレビューの視点 005 [コードレビューの視点]

独り言コメントは書かない

コードレビューをしていると何の役にも立たない「独り言コメント」に遭遇することがあります。たとえば、最近見たのは、次のようなものです。
// やりたくないけど仕方なく
これだけでは、何が問題でどのように対処しようとしているのかが全く述べられていないため、コメント行の後に書かれているコードを見ても、そのコードが行っている処理の理由が全く分かりませんでした。結局、説明してもらって問題が分かり、コメントを書き直すように指示しました。

15年前に見た別の例では、次のようなことが書かれていました。
/* マイクロソフトのコンパイラが馬鹿だから */
この時も、コメント行の後のコードを見てもコンパイラにどのようなバグがあったのか全く分かりませんでした。ここでは、ある言語仕様に対してどのようなバグがコンパイラにあって、それを回避するためのコードであることがコメントから分かる必要があります。あるいは、ひょっとしたら、コンパイラにはバグは無くて、書いた人が何かを誤解していたのかもしれません。残念ながらその時は誰が書いたコメントであるかは分からなかったので、具体的な内容を知ることができませんでした。

会社の資産としてのソースコードに「独り言コメント」がたくさんあるとしたら、コードレビューをしない組織か、コードレビューをしてもきちんとしたレビューができない組織でしょう。


スポンサーリンク





nice!(0)  コメント(0)  トラックバック(0) 

nice! 0

コメント 0

コメントを書く

お名前:[必須]
URL:
コメント:
画像認証:
下の画像に表示されている文字を入力してください。

Facebook コメント

トラックバック 0

トラックバックの受付は締め切りました