目的
コードレビューは見る人によって観点が異なる。
汎用的な内容をまとめる
見るべき項目
機能
バグ
セキュリティ
可読性
テスト
パフォーマンス
ドキュメント
設計
……などなど
機能
・機能要件を過不足なく実装・動作しているか
・仕様が明確ではない部分を勝手に実装してないか
コード
・コーディング規約に準拠しているか
・一時的に使用した不要なコードが残ってないか
・ネストが深くなりすぎていないか(3重くらいまで?)
・ハードコーディングしてないか
・同一のロジックが2箇所以上で書かれていないか(例外あり)
・適切な例外処理が入っているか
・実装が適切か(特にクラス分割など)
・設計レベルの指摘はコメント残すより直接話した方が早い?
命名
変数
・変数名から内容が予測できる名称になっているか
・長さはあまり気にしないが、安易に長い名前はつけない
関数
・関数名は機能を明確に表したものになっているか
・メソッド名からは予測しにくい副作用が入っていないか
get〇〇なのに、内部でsetしている
コメント
・コメントが適切か
・コードからすぐわかることを書いていないか
・特殊なロジックが入っている場合処理の内容ではなく「なぜ」や「意図」を書いているか
・複雑な処理の場合はコードブロックでの要約は書いた方がよい
画面
・利用者視点(特に誰が、どのように使うか)という点で適切な文言・動作になっているか
・操作する上で足りてない情報、多すぎる情報がないか
・視覚情報として見やすいかどうか(違和感のある表示じゃないか)
レビュー粒度
・できる限り小さい粒度で依頼すること
※差分が多すぎると、レビュワーの負担が大きくなり細かいところまで見切れなくなる可能性があります。
一つの機能追加のチケットでも画面毎や区切りのつく単位毎にする。
遠慮しない
・特に自分はできていないけど・・・みたいなときでも改善すべき点があるなら指摘する。
・違和感がある箇所があれば「なぜこのように書いたのか？」を質問するだけでも良い。
以上