やってはいけないコードレビュー
トピック「コードレビュー」について
こうならないようにと、気をつけていること
- 規約に従っているか
ツールでやる。最初に規約を提示する、教育する。
規約の後出しダメ絶対
- 好意的に進んで解釈する
初見でわからない構造、説明をきいてすっとはいらない構造
頭を捻ってみて理解できちゃうと、「入出力が合ってるならまぁ良いか」
という気になってしまう。
書いた人も自分も他の人も明日には理解できない可能性があるので、
わかりませ~ん。と馬鹿になるようにしている。
- コードを見ながら仕様を検討
レビュー受ける側にとっては時間の無駄。
コードみてから外部仕様を再検討したい思いに駆られることがある。
この時の検討はたいていおかしなところに着地する。
もしくは、付け焼き刃になって傷口を広げる。
だから別の場所と時間で検討してから、開発してもらう。
- 英語のスペルミスばかりをチェック
スペルミスは当然指摘しますが、そればかりに執着しない
- 不具合修正をレビューしない
変なコードが生まれるのは急場、鉄火場
「時間がなかった」を免罪符にできる場合とできない場合があるので、
時間をかけるべきかどうか、言ってあげるのが大事だと思う。
かといって、独りで書いて独り自分のコードをレビューできるほどに
人間できておらず「まぁよいか」の日々。
リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)
- 作者: Dustin Boswell,Trevor Foucher,須藤功平,角征典
- 出版社/メーカー: オライリージャパン
- 発売日: 2012/06/23
- メディア: 単行本(ソフトカバー)
- 購入: 68人 クリック: 1,802回
- この商品を含むブログ (111件) を見る