コマンドライン検査/測定ツール： AuditsCLI.EXE
AuditsCLI.EXE はコマンドライン検査/測定ツールです。 コマンドラインで --audits と --metrics のどちらのオプションが指定されたかに応じて、コマンドライン版の検査または測定を実行します。
- 警告： AuditsCLI.EXE は、Delphi プロジェクトでしか使用できないことに注意してください。
コマンドライン構文
コマンドライン ヘルプを表示するには、次のように入力します。
AuditsCLI {-h|--help}
検査を実行するには、次のコマンドラインを使用します。
AuditsCLI --audits --{html|xml} CompilerOptions ^[--config=AuditsConfigurationFile.ADT] [-o OutputFile] ProjectName.DPROJ
測定を実行するには、次のコマンドラインを使用します：
AuditsCLI --metrics --[html|xml] CompilerOptions ^[--config=MetricsConfigurationFile.MTS] [-o OutputFile] ProjectName.DPROJ
コマンドライン オプション
次のコマンドライン オプションを指定することができます。
| オプション | 説明 |
|---|---|
|
|
このオプションのいずれかを指定すると、簡単なヘルプがコンソール ウィンドウに表示されます。 |
|
|
このオプションのいずれかを指定する必要があります。
|
|
|
このオプションのいずれかを指定する必要があります。
|
|
|
Delphi コンパイラに関連するオプションを指定します（「Delphi コマンドライン コンパイラ： DCC32.EXE」参照）。以下のオプションを指定することができます。
|
|
|
分析対象の検査セットまたは測定セットを格納したファイルを指定します。 分析時には、このセットに格納された検査または測定のみが処理されます。
構成ファイルは IDE から作成することができます。 ［QA 検査］および［QA 測定］のダイアログ ボックスを使って、アクティブな検査や測定のセットをカスタマイズします。 その後、ダイアログ ボックスにある［検査セットの保存］または［測定セットの保存］のボタンを使って、カスタマイズした検査または測定のセットを構成ファイルに保存します。
|
|
|
|
|
|
Delphi プロジェクト ファイルを指定します。 このファイルの拡張子は |
コマンドラインの例
以下に示すのは、コマンドライン測定を実行する例です。
AuditsCLI.exe --metrics --html^--config="C:\Users\<user>\Documents\Embarcadero\Studio\Projects\MyMetrics.mts"^-U"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\release"^-o "C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\QA\MyMetricsResults.html"^"C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"
ここでは：
--htmlオプションでは、測定結果を HTML 形式で生成するよう指定しています。MyMetrics.mtsファイルには処理対象の測定セットが格納されています。 このファイルは、［QA 測定］ダイアログ ボックスであらかじめ作成しておく必要があります。-Uオプションでは、コマンドライン測定で次のフォルダ内にあるコンパイル済みユニットを検索することを定義します：
C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\releaseフォルダ。
-oオプションでは、生成した測定結果をMyMetricsResults.htmlファイルに保存するよう指定しています。Project1.dprojファイルは、コマンドライン測定でソース コードを分析する対象のプロジェクト ファイルです。
以下に示すのは、コマンドライン検査を実行する例です。
AuditsCLI.exe --audits --html^--config="C:\Users\<user>\Documents\Embarcadero\Studio\Projects\MyAudits.adt"^-U"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\release"^-I"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\19.0\include"^-DDEBUG;DEVELOPERS;^-o .\MyAuditsResults.html^"C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"
ここでは：
-Iオプションでは、コマンドライン検査が使用するインクルード ディレクトリを定義します：
C:\Program Files (x86)\Embarcadero\Studio\19.0\libおよびC:\Program Files (x86)\Embarcadero\Studio\19.0\includeインクルード ディレクトリ
-Dオプションでは、DEBUGおよびDEVELOPERSという条件付きコンパイル シンボルを使用するよう指定しています。.\MyAuditsResults.htmlファイルで使われている相対パスは、プロジェクト ファイル オプションで指定したプロジェクト ルート ディレクトリ
C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1の中にこのファイルを作成することを意味しています。