PhpStormでのコード解析 ~InspectCode設定~

概要

PhpStormにあるコードチェック機能の「コード・インスペクション」を触ったので備忘録。

※PhpStorm : JetBrainsが提供しているPHP用のIDE（統合開発環境）

利用方法

• 上部メニューバーの「Code」 > 「Inspect Code...」
• ファイルやディレクトリを選択して右クリック > 「Inspect Code...」

設定内容

• Inspection scope
  • チェック範囲の指定
  • 下記の3項目から選択
    • Whole project （プロジェクト全体）
    • Directory '...XXX'　（指定されているディレクトリ配下）
    • Custom scope　（自身で登録したカスタム設定を使用）
• Inspection profile
  • チェック項目を指定
  • 特定言語やサービスのチェックを選択やカスタマイズ可能

Custom scope

• ダイアログ左上部の「+」「-」でスコープ（チェック範囲）の設定を作成/削除できる
  • Name: スコープ名　（先述の Custom scope でプルダウン表示される）
  • Patten: スコープのパターンを記述　（下記のファイル表示でも指定可）
  • ファイル表示: ディレクトリ構成が表示されており、「Include」などのボタンで指定（上記のPattenにも連動される）

Patten 設定
簡単な指定方法を紹介

• 拡張子を指定
  • file[プロジェクト名]:xxx/*.php
  • プロジェクトのxxxディレクトリ配下にある.phpファイルを指定　（ディレクトリ直下以外も再帰的に指定）
• 再帰的にディレクトリ配下を全て指定
  • file[プロジェクト名]:xxx//*
  • / （ディレクトリ直下のみ指定）
  • // （ディレクトリ内を再帰的に指定）
  • 拡張子指定した場合は "/" で再帰的に指定するようです
• 除外指定
  • !file[プロジェクト名]:xxx//*.html
  • プロジェクトのxxxディレクトリ配下にあるHTMLファイルを除外
• 組み合わせ
  • AND指定 : &&
  • OR指定 : ||

おまけ

プロジェクト全体のチェックではPCのメモリ使用や負荷が大きかっため機能毎に分割してチェックしました。
問題ないコーディングでも構文的なチェックでWarning出る可能性があるため、「Inspection profile」でチェック項目を変更するか、「インスペクションの抑止」のコメント追加で対処が可能です。

参照

• コード・インスペクション
  • https://pleiades.io/help/phpstorm/code-inspection.html#gsc.tab=0
• スコープ
  • https://pleiades.io/help/phpstorm/settings-scopes.html
• インスペクションを無効にして抑制
  • https://pleiades.io/help/idea/disabling-and-enabling-inspections.html