コードレビュー 開発者ガイド
はじめに
コードレビューとは、コードの作者以外の誰かがそのコードを確認するプロセスです。
Google では、コードと製品の品質を確保するためにコードレビューを活用しています。
このドキュメントは、Google のコードレビューのプロセスとポリシーに関する正式な説明です。
このページは、コードレビューのプロセスの概要となっています。このガイドは、次の2つの大きなドキュメントからなります。
- コードレビューの方法: コードレビュアのための詳しいガイドです。
- CL の作者のためのガイド: コードレビュー対象の CL を作成する開発者のための詳しいガイドです。
コードレビュアは何を期待するべきか？
コードレビュアは、以下の点について確認しなければなりません。
- 設計: コードはよく設計されており、あなたのシステムにとって適切なものですか？
- 機能: コードは作者が期待している通りに振る舞いますか？ コードの振る舞い方は、コードのユーザーにとっても良いものですか？
- 複雑さ: コードをもっと単純にすることはできませんか？ 他の開発者が将来そのコードに出会ったとき、コードを簡単に理解できて使うことができますか？
- テスト: コードには、正しく、よく設計された自動化テストがありますか？
- 命名: 開発者は変数・クラス・メソッドなどに明確な名前を付けていますか？
- コメント: コメントは明確で役に立ちますか？
- スタイル: コードは Google のスタイルガイドに従っていますか？
- ドキュメント: 開発者は関連するドキュメントも同時に更新していますか？
さらに詳しい情報については、コードレビューの方法を読んでください。
最適なレビュアーを選ぶ
一般的に、合理的な時間内で、あなたのレビューに責任を持つことができる人物の中で最高のレビュアを探すように努めます。
最高のレビュアとは、あなたが書いたコードに対して、最も完全で正確なレビューを与えることができる人物のことです。通常、その人物は OWNERS ファイルにかかれているかどうかに関わらず、コードのオーナーを意味します。そのため、時には CL の異なる部分ごとに別々の人物にコードレビューをお願いすることになることもあります。
理想のレビュアを見つけたものの、その人がレビューできない場合でも、少なくともあなたの変更について、その人たちに CC するようにします。
対人レビュー
良いコードレビューができると認められた人とペア・プログラミングをして書かれたコードの場合、そのコードはすでにレビューされたとみなします。
対人コードレビューを行うこともできます。対人コードレビューでは、レビュアーは開発者に質問を行い、変更の開発者は話し掛けられたときにだけ答えます。
関連項目
- コードレビューの方法: コードレビュアのための詳しいガイドです。
- CL の作者のためのガイド: コードレビュー対象の CL を作成する開発者のための詳しいガイドです。