SSブログ

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

説明とコードが違っていないか注意する

コードレビューでは、クラスの役割を説明してもらった後に、メソッドの処理内容を説明してもらいます。本来はその両方がきちんとjavadoc形式で記述されていれば良いのですが、先に説明を書いてからプログラミングする人は少なく、頭の中で考えてそのままプログラミングされることが多いです。そのため、コードレビューでも説明が必要となります。

その説明では、本人が書いた気になっている処理を説明します。しかし、レビューアーは、その通りの処理になっているかをコードを理解しながら確認する必要があります。実際、コードレビューでは、本人が意図した通りの実装になっていないコードを目にする場面が多くあります。

特に注意しなければ、自動テストコードが書かれていたり、あるいは手作業でテスト済みであるような場合です。つまり、「テスト済み」と本人が思っているコードであれば、考えていた通りの処理になっていると書いた本人は思い込みでコードを説明する可能性が高くなります。しかし、コードが間違っていて、テストも正しい期待する動作をテストしていなかったりすることがあります。

コードレビューでは、レビューアーは説明とコードが食い違っていないかに注意を払う必要があります。
nice!(0)  コメント(0)  トラックバック(0) 

nice! 0

コメント 0

コメントを書く

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

Facebook コメント

トラックバック 0