コードレビュー時に気を付けるべき6つのポイント

コードレビューの必要性 

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90％、年休124日以上 etc.　　詳細はこちらから＞

システム開発の一環として、プログラムの作成はシステム実現の重要な工程の一つ。 

高品質なシステム作成には、質の高いコードを維持することが大切です。 

そして、その高品質なコードの維持には、コードレビューは必要不可欠な工程になります。 

とはいえ、コードレビューが初めての方からすれば、一体どんなポイントに気を付けてコードレビューをしてあげれば良いのか不安に思うこともあるでしょう。

そこで今回は、コードレビュー時に気を付けるべき6つのポイントをご紹介します。

コードレビューのポイント 

具体的に”品質の高いコード”とはどんな状態を指し、どうコードレビューをすればその状態を維持できるのか。

ITベンダーで実際に後輩のコードレビューを普段から行っている私が考える、コードレビュー時に気を付けるべきポイント6つを列挙しました。

①目的が明確に表現できるか？

　設計上の機能は正しく反映するのが基本です。 

　１つの機能について、なにを基に、なにを取得するかを明確にしましょう。 

　コード上、IN（元情報）／OUT（結果情報）が合っているかどうかは非常に重要です。 

②可読性はよいか？

　１つの親機能に複数の子機能が存在することは多いでしょう。 

　そのため、各子機能がなんの処理をするためのものなのかをコメントで説明するのは基本中の基本です。 

　システムの不具合対応や改修作業、コード修正作業などが発生した際、 

　コメントの記述がしっかりしていれば、修正箇所の探す時間は大幅に減らすことができます。 

③コードルールを遵守する 

　組織全体でシステムを管理するため、システムには共通ルールがあります。 

　各システムごとに独自で管理するため、各システム独自のルールがあることもしばしば。 

　そのため、コード作成時は上記の各ルールを守られているかもきちんと確認しましょう。 

④パフォーマンスに問題はないか？ 

　システム運行時、１つ機能の実行には時間がかからないため、 

　以下の内容よりコード作成の必要があり、コードの可読性にも影響します。 

1. 　a.ネストは深くしてはいけない。 
2. 　b.多重ループは避けた方がよい。 

⑤エラー時の対応は問題ないか？

　１つの機能について、正しい結果／エラー結果の両方の対応方法は 

　コード作成時の時点で考えている必要があります。 

　エラー対応に問題がある場合、システムに大きな影響を与えてしまう可能性があります。 

⑥拡張性はよいか？ 

　システムのバージョンアップ時は、コード修正／追加が発生するものです。 

　複数機能は１つのソースにまとまると、コード修正量が多く、問題発生しやすい場合があります。 

　そこで、適当な機能分けでソース作成する場合、今後の対応工数は大幅に減らすことができます。 

コードレビュー際には、ぜひ上記6つのポイントを意識してみてください。 

コードレビューの人間性 

レビューを行う側の人をレビュアー、レビューされる側の人をレビュイーといいます。 

レビュアーはシステムの仕様、ルール、プログラムなどに強い必要があります。

ですが、書かれたコードのすべてに精通している人がいない場合もあるでしょう。

そうした際には、複数人で分担し、それぞれが詳しい領域を担当してレビューする場合もあります。 

レビュイーの作業レベルはそれぞれ違います。 

そのため、特に新人のメンバーには、上記のレビューポイントはしっかり実施する必要があります。 

一方で、何年、何十年と経験のあるベテランだと、上記のレビューポイントについて、

自分の作業習慣、システムの業種などによって、ある点に偏ることもあります。 

レビュアーはそれを考えて、レビュー時間を減らす工夫もしてみましょう。 

【エンジニア募集中】フルリモートも◎(リモート率85.7％)、平均残業8時間、年休124日以上、有給取得率90％ etc.　詳細はこちらから＞