## コードレビューの概要と目的

**コードレビューとは、作成したソースコードをレビューすることで、記述ミスやバグがないかを確認する作業のことです。**プログラムの品質を向上させるために、必要不可欠な工程といえます。ここでは、コードレビューの重要な観点を把握するために、まず概要や目的について詳しくご紹介します。

**コードレビューとは記述したソースコードに間違いがないかどうかを自分以外の誰かに確認してもらうことです。**レビューを行う側の人をレビュアー、レビューされる側の人をレビュイーといいます。レビュアーは複数いる場合もあります。

*システム開発の際にコードレビューはよく実施されます。*例えば、システムの品質を担保するために、「レビュアーの許可がない場合にはコードを修正することができない」というルールを作るプロジェクトもあります。プロジェクトの発足時に、レビューにかかる工数の見積もりやレビューのルールを決めることが大切です。

**コードレビューの大きな目的は、システム品質の向上です。**レビュアーに作成したコードに対して指摘してもらうことで、コードをより良い方向に修正することが可能です。例えば、人間がコードを記述する場合、ケアレスミスは発生します。そのため、*コードレビューを行うことで客観的にコードを見てもらえるため、ケアレスミスに気づきやすく、結果としてシステム品質の向上が期待できます。*

また、**コードレビューは新人教育のために実施されることも多いです。**新人社員の場合、実務経験が豊富な上司と比較するとコードの実装スキルがありません。そのため、ソースコードを読む作業を通じて、新人社員はコーディングについて多くのことを学ぶことができます。例えば、他人のコードを読むことによって「コードの設計」「コードの書き方」「フレームワークのスキル」などを勉強することが可能です。*コードレビューを通じて開発者の意図を学べるため、スキルアップにつながります。*

さらに、新人社員の場合はコードを丁寧に読むことが多く、実務経験が豊富な社員だとコードレビューを行うことに慣れていることが多いため、ケアレスミスを見逃してしまうこともあります。そのため、新人社員がコードレビューを行うことで小さなミスを拾えることもできるので、**新人教育も兼ねてコードレビューを行うことも多いです。**

**コードレビューの目的が理解できたら、次は方法が重要です。**コードレビューの方法はプロジェクトによって異なることも多く、ここでは一般的なコードレビューの方法について詳しく紹介します。ただし、例外もあるので注意してください。

### コメントの種類を使い分ける

**コードレビューをする際のコメントは、主にレビュイーが対応しやすいように記述します。**そのためには、行間のない短文で理解しやすいコメントが大切です。*コメントは、対応必須の「MUST」とレビュアーの意見「IMO（In My Opinion ）」の2つに分類すると分かりやすいです。*また、細かい指摘を行う項目など他の要素を使うこともあります。

### コメントの仕方に気を付ける

**コードレビューにおけるコメントは、コミュニケーションの一貫にもなります。**そのため、コミュニケーションがスムーズになるようなコメントの仕方も大切です。プロジェクトによっては文字のみだけではなく、絵文字や記号を使用することもあります。

また、*コードレビューでは相手の良い点を褒めることも大切です。*例えば、上司がレビュアーで新人社員がレビュイーの場合に、新人社員が成長した点をコメントしてあげると、新人社員のモチベーションアップにもつながります。

厳しい指摘ばかりしていると、レビュイーにとってコードレビュー自体が「辛い」「怖い」とネガティブなイメージになる原因になります。また*コメントをメンバーに共有することで、チーム全体の学びにもなるでしょう。*

**レビュアーがコードレビューの際にコメントを記載するときは、理由や根拠もきちんと記述しましょう。**コメントで「〇〇に修正してください」だけだと、レビュイーは「なぜ？」と疑問を抱いてしまうことがあるので、*根拠を示すことで新人社員の学びにもつながります。*インターネット上の信用できる参考文献を利用して、コメントをした理由を記述しましょう。

参考文献としておすすめの本は「リーダブルコード―より良いコードを書くためのシンプルで実践的なテクニック」です。イラスト付きで解説されているため分かりやすく、日本語の解説もついています。

【参考】：[O'Reilly Japan-リーダブルコード](https://www.oreilly.co.jp/books/9784873115658/)

### マージ後でも修正可能かを意識する

**マージを行った後でも、修正可能かどうかを意識することは大切です。**レビューの修正はマージを実施した後でも少ない工数で修正することができます。一方、データベースの変更は修正するための工数が大きくなるので、マージ後に修正が大変かどうかを意識してレビューを行うことも重要です。

**相手に伝わりやすくコードレビューを実施するには、いくつかコツがあります。**コードレビュー初心者の方は、まず基本的なコツをおさえておきましょう。ここでは、コードレビューをするときに意識すべき3つのコツについて説明します。

コードレビューを初めて行う人必見！やり方を1から解説！

### 口頭でのレビューも利用する

コメントのみでのレビューが難しいこともあります。その場合は**対面レビューの口頭でレビューを行うことがおすすめです。**ただし、指摘内容についてはコメントとして残しておいた方が、あとでエビデンスとして活用できます。また、プロジェクトメンバーに共有することもできるので、チーム全体の学びにもつながるでしょう。

### コードレビュー観点のチェックリストを用意する

**コードレビューをする際には、チェックリストの準備も大切です。**チェックリストを用意することで、*コードレビューする際の抜けや漏れを減らすことができます。*また、コードレビューをどのような観点で行うか、チームで認識合わせが可能です。

### 進捗に応じて確認するポイントを変える

**進捗状況によって、コードレビューをするポイントを変えることも重要です。**作業途中のコードを「WIP」として、プルリクエストを出す方法もあります。WIPとは、「work in progress」の略称で、進行中や作業中のことを指します。プルリクエストとは、コードの修正をレビュワーに通知して、マージを依頼することです。*WIPの場合は、変更の前提となるところを重点的に確認します。*

例えば、コードの設計や実装の方針について問題はないかを確認することが多いです。また、この段階では細かい部分の指摘は不要です。コーディングが完了した後に、細かい部分についてもレビューを行います。

## コードレビューで指摘が多いポイント

ここではコードレビューの際に指摘が入りやすいポイントについて説明します。間違いやすいところは重点的にチェックし、バグの防止やレビューの効率化を目指しましょう。下記で説明する項目について詳細なチェックリストを作成すると、精度の高いコードレビューができます。

**仕様のとおりに実装されているか、UIが適切か、エラーを正しく返すことができるかなどの基本的な機能部分をまずチェックしましょう。**簡単なコードでもケアレスミスがないとは言えません。機能に影響する部分はユーザーに直接見えるものが多いため、重点的にチェックしてください。

**不要なロジックが残っている、コピペミスがある、同一のロジックが複数入っているなどは必ず指摘しましょう。**コードの記載ミスは、製品がバージョンアップされたときや新たにアサインされたメンバーが加わる場合など、開発を再開する際にトラブルの元になります。複数のメンバーで開発ができるよう、コードは読みやすく書くことが大切です。

複数の端末で接続した際に処理速度が低下する、重い処理が含まれているといったパフォーマンスの低下の原因となる部分もチェックすべきポイントです。**具体的には指定されたデータ型が正しい、可能ならトランザクションを使用する、外部リソースへアクセスする場合は1回にまとめるなどの対策をしましょう。**

**コードレビューは、工数やコストが多くかかることも少なくありません。**近年ではIT人材の人手不足が深刻化していることもあり、納期などの問題からコードレビューができないことも多いです。品質を一定に保つためには、レビュー効率を上げる必要があります。ここからは、*レビュー作業の効率向上に用いられるコードレビューツールを2つご紹介します。*他にも多数のコードレビューツールが存在しているので、ぜひニーズに合うツールを探して利用しましょう。

主要なコードレビューツールを紹介！ツールがなぜ必要かについても解説

**GitHubには、プルリクエストの画面にコードレビューのツールがあります。**無料でも使用できますが、データ量やアクション数などに制限があるため、企業単位でツールを活用する場合には有料プランの選択がおすすめです。GitHubを利用することで、レポジトリへのアクセス権があるメンバーに対して、プルリクエストごとにレビュアーとして割り当てることができます。プルリクエストを行ったエンジニアは、管理者に対してコードレビューの依頼が可能です。

*コードレビューツールを活用すれば、Gitにおけるコンフリクトをインターフェース上で解決できます。*また、追加したレビューツールと統合させることもでき、レビュー機能を拡張することも可能です。そのため、GitHub付属のコードレビューのツールは、すでにGitHubを利用している場合には、追加のインストールや設定が不要なことから最適なツールと言えます。

【参考】[GitHub](https://github.co.jp/)

**Review Boardとは、オープンソースのコードレビューツールでコードとドキュメントのレビューができます。**また、コードの比較を画面でわかりやすく表示することもできます。さらに、Webサイト上で試験版を利用でき、ソフトウェアをインストールして自身のサーバーで設定することも可能です。

*Review Boardはオープンソースということもあり、バージョンは日々更新されているため、使いやすいツールに日々発展しています。*また、Review Boardは他のツールと比較して学習曲線が緩やかなことも特徴です。

【参考】[Review Board](https://www.reviewboard.org/)

## コードレビューはシステム開発において大切な工程の1つ！

これまでに、コードレビューの概要・注意点・コツ・指摘ポイント・ツールについて詳しく解説しました。コードレビューとは、記述したソースコードを他の方が問題ないか確認する作業のことです。**コードレビューの最大の目的はシステム品質の向上です。**また、新人社員の教育としてコードレビューを利用することもあります。

*コードレビューのやり方として、コメントの仕方が特に重要です。*コミュニケーションの一貫ともなるので、コメントで絵文字の活用や対面レビューもおすすめです。また、コメントではよかった点について積極的に褒めることも意識してください。近年ではコードレビューツールも多くあるので、コードレビューに割ける時間がない方はぜひニーズに合わせて活用してください。

コードレビューとは、記述したソースコードに問題がないかどうかを自分以外の誰かに確認してもらう作業を意味します。また、コードレビューの最大の目的はシステム品質の向上で、新人社員にも任されることが多いです。当記事では、コードレビューの重要な観点について詳しく解説します。

コードレビューとは、記述したソースコードを自分以外が問題ないか確認する作業のこと

コードレビューの最大の目的はシステム品質の向上である

コードレビューツールを利用することでレビューの効率の向上が期待できる

コードレビューの観点とは？やり方や便利なツールについても紹介！

まずはコードレビューの*基本的なやり方を解説*します。どういう手順で行うべきか、1から説明します。初めてコードレビューを行う方は、まずはこちらをお読みください。

コードを読む前に、まず**「システムの仕様を把握すること」が重要**です。どのような機能をもつシステムなのか仕様を把握しないと、コードのどこを指摘したらいいのか分からず、仕様通りに書かれていない箇所の指摘もできません。

また、*コードレビューに慣れていない場合、仕様を頭に入れていないとコードが読み解けないことも多い*です。新人のコードレビューをする場合は、新人が関わっている箇所の仕様書を読み込み、何を作ろうとしているのか全体像を確認しましょう。

### コードを一通り読んで確認する

仕様書を一通り理解したら、コードを一通り読んでいきます。書き方が良くなかったり、非効率な処理をしていたりする部分などがあれば*メモ*しておきましょう。

また、**コードを自分の開発環境でも実行し、エラーが出ないかもチェックします。**開発環境が変われば、エラーが発生するケースも多いためです。こういった地道が作業が、コードレビューでは必要です。

メモした内容を基に、問題点を*口頭・Github・チャットツールなどで指摘*します。また問題点を指摘する上で、参考にした資料などがあれば提示・添付すると良いでしょう。新人が問題点に関する質問をしてきたら、きちんと答えられるようにしておくことも重要です。レビューをする際は**同じミスを繰り返さないよう、相手に分かりやすく伝えることを意識しましょう。**

## コードレビューで見るべきポイント

ここでは、コードレビューで見るべき具体的なポイントを紹介します。特に*コード量が多い場合、最初から最後まで熟読するのは大変*です。見るべきポイントを抑えて、そこを重点的に確認すれば、*コードレビューの時間を短縮*できるでしょう。1つ1つのポイントを詳しく解説していきます。

### 自社のコードルールに則っているか

まずは、**自社のコードルールにしっかり則って書かれているコードか**確認しましょう。インデントやコメントの書き方など、それぞれの会社でルールが設けられているはずです。

他の会社でエンジニア経験がある方の場合、*自社のコードの書き方ではなく、前職での書き方をそのまま使っているケースも多い*です。そういった場合は、自社のコードルールに則っていない旨を指摘しなければなりません。レビュー時はコードが自社のルール通りなのか、確認してください。

### コメントが分かりやすく書かれているか

コメントが分かりやすく書かれていないと、*仕様変更を行う際や他の人に担当部分を引き継ぐ場合に苦労します。*エンジニアによっては、コメントを全く書かない人や、逆にコメントが多すぎる人もいます。*ソースだけでなく、コメントが上手く挿入されているか確認する*のが良いでしょう。

### バグを生み出しやすい部分がないか

コードレビューを行う主な目的は、「バグを潰す」であることがほとんどです。プログラマーを数年続けていると、どの部分がバグを生み出しやすいか感覚が掴めていると思います。その感覚を頼りに、*バグが出そうな部分を重点的にチェック*しましょう。

たとえば、if文がネストされている部分や無限ループが使われている部分、変数名が分かりにくい部分などはバグが出やすいです。また、**なるべぐバグを生み出しにくいコードを書くように指示する**ことも大切です。

### 仕様変更の際に修正箇所が多くならないか

コードレビューの際は、**今後の仕様変更のことも考えて行いましょう。**仕様変更が発生すると予想される箇所のコードは、修正部分が少なくなるよう記述するのが重要です。たとえば、*同じような処理を関数にまとめる*などが該当します。後に修正箇所が多くなりそうな部分も、コメントしてあげることが大切です。

*例外処理が入っていない場合が割と多い*ため、そこも重点的に確認しましょう。ユーザーが想定外の動作を行った場合に、プログラムがエラー文を出さないかチェックします。例外処理が入っていない場合は、**例外処理を書く必要があることの旨と、書き方の例をコメント**しておきましょう。

## コードレビューを効率化させる方法

コードレビューは、*あまり時間をかけすぎるのも良くありません。*時間をかけすぎて自分の業務に影響が出てしまうことがあります。そこで、コードレビューを効率化させる方法を解説します。レビューすべきコード量が多い場合などは、これらを意識してみてください。

### レビューの目的を明確にする

**レビューの目的を明確にすることは重要**です。たとえば「バグをなくす」「効率的なコードの書き方を教育する」など、目的はそれぞれ異なります。レビューの目的が決まれば、その部分のみに絞って効率的にチェックできるでしょう。

### 自動コードレビューサービスを使う

「自動コードレビューサービス」というものもあります。コードを入力すると、**ツールがコードを自動解析してくれ、問題点をコメント**してくれます。たとえば、「Sider」は日本初の自動コードレビューサービスとして有名です。また、解析ルールをカスタマイズし、自社仕様にすることもできます。

もちろん、*こういったサービスに頼り切るのは良くありませんが、要所で活用することでレビュー時間を短縮できるでしょう。*「Sider」以外にも「Codacy」や「Hound」などいくつか種類はあるので、試しに使ってみてください。

レビューする箇所が多すぎる場合は、*役割分担を行うことも検討*しましょう。たとえば「コードが仕様書通りか確認する人」と「コードの書き方が規約に則っているか確認する人」に分けるなどです。

**役割分担することでピンポイントで確認でき、レビューの質も上がる**でしょう。役割分担に関しては、上司に相談してみるのが良いです。

アジャイル開発の特徴、メリット・デメリット、DXとの関係など

コードレビューする際の注意点も解説していきます。これらの注意点も意識しないと、新人との関係を悪くしたり、レビューの質低下に繋がったりします。*ある程度コードレビューを行ってきた人も、注意点を守れていないことが多い*です。どういった点に気をつけるべきか、1つ1つ解説していきます。

コードの悪いところを否定しても、*その人自身は否定してはいけません*。「なぜこんなこともできないのか」と、高圧的な態度を取るのも止めましょう。新人との関係を悪くしたり、相手がコードレビューを嫌いになることに繋がったりします。

悪い箇所を指摘する際は、**淡々と事実のみを話し、自分の感情を介入させないようにしてください。**また、絵文字などを使って柔らかい雰囲気を出すのもコツです。柔軟な対応を見せることで、レビュイーが新人でも萎縮することなく疑問点を質問してくれるようになるでしょう。あくまで「レビューするのは相手に対してではなく、コードであること」を意識するのが重要です。

### なぜこうすべきか根拠を話す

悪い部分を指摘する際はなぜこのような書き方をすべきか、*根拠を話すことも重要*です。たとえば「コード規約に書かれているから」という説明では、相手は納得できません。

コード規約に則るとどんなメリットがあるか、分かりやすく話すことが重要です。そうすることで初めて相手は納得し、改善もしやすくなります。

また、**レビューする際に参考にした本などがある場合は、それを見せるのも効果的**です。「なぜそうなのか」をきちんと説明することは、コードレビューをやる側の理解度アップにも繋がります。

コードレビューをする際は、*具体的な修正案も示してあげましょう*。その方が相手がどのように変更すべきか分かりやすくなります。また、**言葉ではなかなか伝わりにくい部分も理解させることが可能**です。もちろん、具体的な修正案を示すのは時間もかかるため、できる範囲で行いましょう。

悪い部分を指摘するだけでなく、*良い部分があれば褒めるようにしましょう。*コードレビューを行う上で大切なのは、**やる側とやってもらう側の信頼関係**です。悪い部分ばかり指摘するのは、信頼関係を築く上で好ましいことではありません。

また、良い部分を褒めることで、エンジニアとしての自信がつき、レビュイーの成長速度を早めることにも繋がります。良い部分や「なるほど」と思う部分も必ずあると思うので、コメントしてあげるようにしましょう。

書き手の意図が分からない部分は、*「なぜこういう書き方をしているのか」直接本人に質問*しましょう。質問することで、レビュアーの読解力が不足しているのか、コードの書き方に問題があるのかが分かります。

また、レビュイーの説明力や理解力をアップさせることにも繋がるでしょう。ただし、**問い詰めるような言い方はせず、穏やかな雰囲気を意識して対応することが重要**です。

## コードレビューはやる側もエンジニアとしての成長に繋がる

本記事では、コードレビューのやり方について解説しました。どういった手順でコードレビューを行うべきか、お分かり頂けたかと思います。

コードレビューはやってもらう側だけでなく、やる側もエンジニアとしての成長に繋がります。コードレビューを行うことで、読みやすいコードはどういった物なのか分かってくるため、*自分のコードを確認する上でも役立つ*でしょう。

ただし、時間をかけすぎると自分の業務に支障が出るため、**効率的にレビューを行うことも重要**です。コードレビューを頼まれた場合は、本記事で解説したことを意識して行ってみてください。

リモートで働くエンジニアの実態やメリット、デメリットについて紹介

本記事ではコードレビューのやり方を解説します。エンジニア2、3年目になると新人のコードをチェックする機会もあるでしょう。そこで、コードレビューで見るべきポイントや、効率的に行う方法を解説します。コードレビューをする予定のある方はぜひご覧ください。

コードレビューを行う際は見るべきポイントを抑える

コードレビューは時間をかけすぎるのも良くないため、効率的に行うことを意識する

コードレビューはやる側もエンジニアとしての成長に繋がる

コードレビューの記事（1ページ目）