コードレビューとは？メリットや観点・効果的なやり方も紹介

「コードレビュー（ソースレビュー）」とは、ソフトウェア開発の質を高めることなどを目的として行なう、ソースコードのレビューです。手順が明確に決まっているわけではないため、どのような狙いで実施しているのか曖昧なままになっている部分もあるかもしれません。

そこで今回は、コードレビューを行なうメリットや、実施の際の観点について説明します。また、コードレビューの効果を高める方法についても併せて紹介するので、ぜひ参考にしてみてください。

コードレビューとは

まずは、コードレビューのメリットと、基本的な実施方法や心構えについて説明します。

コードレビューのメリット

コードレビューでは、ソースコードを目で見てチェックすることで修正すべき誤りを発見します。誤りとはいえないまでも、「ここを直せばもっと良くなるのでは」というようなアイデアを出し合って、改善のための議論につなげることも可能です。

これによりソフトウェアの品質向上が期待できますが、ほかにも以下のようなメリットが考えられます。

・メンバーのスキルが向上する

・設計などの技術情報が共有される

・コーディングスタイルが統一される

・チーム内のコミュニケーションが円滑になる

どのメリットに期待するかは、チームのメンバー構成やスキルなどによって変わってくるでしょう。例えば、チーム内に新人が多ければ、スキルの向上が優先事項になるかもしれません。メンバー個々の責任や負担を軽減するために、情報共有を重視することも考えられます。

コードレビューの実施方法

コードレビューを「いつ」、「誰が」行なうかは、チームによって違っていても問題ありません。なぜなら、レビューはチームごとの開発プロセスに統合されるべき工程だからです。

といっても、コードレビューを実施しやすいタイミングはある程度決まっています。なかでも、Gitなどのバージョン管理と絡めるのが代表的な方法でしょう。変更をマージする前やプルリクエストのタイミングで、責任者がソースコードをチェックする方式です。

また、ペアプログラミングを導入しているチームでは、ある程度コードレビューが実施されているといえます。ペア作業中に、ナビゲーター役の人がソースコードを確認する場面が多いためです。これについては、関連する記事があるので参考にしてみてください。

コードレビューの心構え

コードレビューでは、つい議論がヒートアップしてしまうことも少なくありません。しかし、チームが険悪なムードになるような事態は避けるべきでしょう。

そのためには、「完璧なコード」を追求しすぎないことです。あまり本質的とはいえない細かい部分に固執したり、何度も修正を繰り返してしまいレビューが終わらなかったりすると、メリットよりも悪影響のほうが大きくなってしまいます。

とはいえ、何か問題があれば指摘しなければならないのがレビューです。指摘をする際には、見直すべきなのはソースコードであり、個々の性格や人格には何の問題もないのだという意識をもつとよいでしょう。それでも、レビューそのものに慣れていない人は、多少のショックを受けるかもしれません。新人が一緒の場合などは、良いところをみつけて積極的に褒めるようにするのもおすすめです。

コードレビューの観点

コードレビューでは、どのような点に注目すべきでしょうか。ここでは、コードレビューを通してチェックしたいポイントについて説明します。

コーディングルールに沿っているか

ルールに沿ったコーディングは、ソースコードの可読性はもちろんチームワークの面でも重要です。具体的なルールはチームの方針や開発対象によっても変わってきますが、おおむね以下のような観点が考えられるでしょう。

・コメントが必要に応じて書かれているか

・識別子のネーミングがわかりやすいか

・アルゴリズムが必要以上に複雑になっていないか

このとき、「人」が行なう意味のあるチェックを意識するのがポイントです。ツールで自動的にチェックできるのであれば、それで十分でしょう。例えば、以下に関するルールはツールによるチェックに適しています。

・字下げにタブとスペースのどちらを使うか

・ファイルの終端に改行を入れるかどうか

意図したとおりの実装ができているか

ソースコードは、仕様や設計を満たしている必要があります。しかし、すべての仕様と設計が、ソースコードと同じ粒度でドキュメント化されているわけではありません。

そのため、コードレビューでは「開発者が何を意図したか」と「そのとおりの実装にできたか」がよりどころになります。以下のような観点でソースコードをチェックするとよいでしょう。

・意図した機能を網羅できているか

・エラーや例外の判定に抜けはないか

・エッジケース（イレギュラーな状況）を想定できているか

自動テストを導入しているチームでは、上記の大半はテスト時にチェックされます。これは、テストによってコードレビューが不要になるということではありません。コードレビューにおいて、「ソースコードとともにテストケースも適切に更新されているか」という観点も追加されることを意味します。

不具合につながる部分がないか

ソースコードを精査すれば、論理的に不具合につながる恐れのある部分をみつけ出すことも可能です。例えば、以下のような観点でのコードレビューも有益でしょう。

・並列処理がデッドロックする恐れはないか

・セキュリティのための判定は十分に行なわれているか

・適切なアルゴリズムが選択されているか（速度が重視される場面で高速な手法を使っているか、など）

ただし、コードレビューは設計をやり直すための場ではありません。根本的な設計変更の必要性にコードレビューの段階になってから気付いた場合は、コーディングにとりかかるよりも前の工程に問題がなかったか振り返ってみましょう。

コードレビューの効果的なやり方

コードレビューにはさまざまなメリットがありますが、実施するには時間と手間が必要です。そこで、コードレビューの実施を助け、効果を高めるための工夫について紹介します。

静的解析ツールを活用する

コードレビューの真価は、「人」がチェックする点にあります。自動化が可能な部分については、積極的にツールを活用するとよいでしょう。

例えば、lintによる静的解析を導入して、不具合の原因になりやすい記述を検出するのは簡単で有効な方法の一つです。また、セキュリティ上の潜在的な問題を検出してくれる静的解析ツールもあります。これらは、コードレビューで効率良く問題を発見するための補助的な役割を果たすでしょう。

自動テストと組み合わせる

コードレビューと自動テストは、互いを補完します。コードレビューで取りこぼした問題は、自動テストである程度検出できるでしょう。自動テストでは検出が難しい問題が隠れていたとしても、コードレビューを実施していれば気付ける可能性があります。

どちらを先に実施するかは、チームごとの開発プロセスによって変わってくるところです。通常は自動テストに合格したあと、変更点をマージするよりも前が、コードレビューを実施しやすいタイミングでしょう。

ナレッジを共有する

チーム内の情報共有やメンバーのスキル向上は、多くの人がコードレビューに期待するメリットでしょう。そのためには、課題管理ツールを利用するのがおすすめです。

課題管理ツールはプロジェクトにおける未解決の問題を一覧し、解決まで状況を追跡するためのものですが、コードレビューにも適用できます。指摘事項を課題として登録しておき、もれなく対応できるようにするのです。このとき、対応済みのものも含めてすべての課題をメンバーが閲覧できるようにしておけば、情報共有やスキル向上にも役立てやすくなるでしょう。

ポイントを押さえてメリットのあるコードレビューを実施しよう

コードレビューは、ソースコードを検査して誤りや改善点をみつけ出す取り組みです。ソフトウェアの品質向上をはじめとする、さまざまなメリットが期待できます。

コードレビューの効果を高めるには、実施する際の観点を意識しながら、ツールや自動テストも取り入れていくのがおすすめです。ポイントを押さえて、実りのあるコードレビューを実施しましょう。