IntelliJを用いたコードインスペクションの実行

名古屋スタジオでサーバーエンジニアをしている若原と申します。
今回は統合開発環境であるIntelliJを用いたコードインスペクションについて紹介させていただきます。

確認環境

今回使用したバージョンは IntelliJ IDEA 2021.3 (Ultimate Edition) です。

IntelliJのコードインスペクション機能とは

プロジェクト内(または特定範囲)のソースコードをスキャンしてコーディング規約に反していたり、文法の誤り、スペルミスなどを検出し一覧で確認することができる機能です。
IntelliJでは設定により検出する項目をカスタマイズして実行することも可能です。

どのようなメリットがあるのか

コードインスペクションを行うことでコードを書いているときに見落としてしまった細かなミスを洗い出すことができます。バグを0にすることまではできませんが、減らすことに繋がります。
また、コードレビューをしてもらう際にレビュアーが細かな指摘をしなくて良くなり、レビュー時間の短縮にも繋がります。
以前執筆させていただいた記事コードレビューについてで触れておりますが、コードレビューはレビュアーの時間を確保しているのでそれを削減できるのは大きなメリットの1つです。

実行方法の紹介

上部メニューのコード - コードのインスペクションを選択します。
インスペクションを行う対象のスコープを選択します。
プロジェクト全体をインスペクションする場合は プロジェクト全体 を選びます。
選択されたファイル を選択することで1ファイルを指定、カスタムスコープ を選択することで作成したスコープに対して実行可能です。(右端にある … から追加可能です。)

カスタムスコープを作成する場合

左上の + からスコープを追加します。
単体のクラスやディレクトリを追加、除外して特定のスコープを作成することができます。
下図はmodelディレクトリ以下のクラスが対象となっています。

結果確認
サンプルコードはPHPで記述しています。
以下のように一覧で表示されるので1箇所ずつ修正を行います。

インスペクションのカスタマイズを行うには

上部メニューのIntelliJ IDEA - Preferencesを選択します。

設定メニューが開きますのでエディター - インスペクションを選択します。
左側のリストから開発に使用している言語を選び検出したい項目にチェックを入れます。

まとめ

インスペクションで検知できる項目はIDEを使っていると波線や背景色の変化などで問題となっている箇所を示してくれますが見落としがちになっていないでしょうか？すべてをまとめて対応しようとすると大変ですが、開発に区切りがついたタイミングやコードレビューに出す前などに変更を加えたプログラムのみでもインスペクションを実行することでプロウラムをきれいに保つことができ、見落としやバグの発見にも繋がります。
継続して行うことで自分がどんなところを見落としがちなのかを気づくこともできますし、実装後のコードを見返す良い機会にもなると思います。まだ使ったことがない人はぜひ一度使ってみて下さい。