コマンド行コード・レビューのリファレンス

このトピックでは、コマンド行インターフェースからコード・レビュー分析を実行する場合に指定する必要のあるパラメーターについて説明します。

目的

コマンド行コード・レビュー・アプリケーションのパラメーターでは、分析のスコープ、ソース・コードの場所、適用するルール、および分析結果の場所を指定します。 このアプリケーションは、分析結果を stdout に書き出すこともできます。

コード・レビュー・コマンド行アプリケーションを実行するための命令は、次の構文で指定します。

Eclipse 実行可能ファイル:

<Eclipse 実行可能ファイルへのパス>eclipse -data <Java ソース・ファイルへのパス> -application com.ibm.xtools.analysis.commandline.AnalyzeApplication -rulefile <ルール・ファイルへのパス> -directory または -projects <Java ソース・コードへのパス> または <プロジェクト名のコンマ区切りリスト> -exportdirectory <結果ディレクトリーへのパス> <オプション・パラメーター>

Java™ ランチャー:

<Java 実行可能ファイルへのパス>java -cp Eclipse startup.jar へのパス org.eclipse.core.launcher.Main-data <Java ソース・ファイルへのパス> -application com.ibm.xtools.analysis.commandline.AnalyzeApplication -rulefile <ルール・ファイルへのパス> -directory または -projects <Java ソース・コードへのパス> または <プロジェクト名のコンマ区切りリスト> -exportdirectory <結果ディレクトリーへのパス> <オプション・パラメーター>
注: スペースを含むパスは、引用符で囲んでください。例えば、次のようにします: "C:¥Program Files¥IBM¥SDP70¥startup.jar"

パラメーター

オプション 分類 パラメーター
-data 必須 Java ソース・ファイルへの完全修飾パス

これは、既存の Eclipse ワークスペース、または一時ワークスペースのロケーションへのパスにすることができます。

-application 必須 com.ibm.xtools.analysis.commandline.AnalyzeApplication

これは、Eclipse コマンド行分析アプリケーションの ID です。

-rulefile 必須 ルール・ファイルへの完全修飾パス
-projects 必須 (ソース・コードが既存の Eclipse ワークスペース・プロジェクトの一部である場合) プロジェクト名のコンマ区切りリスト

ワークスペース・プロジェクトを指定しない場合、コード・レビューはワークスペース内のすべてのプロジェクトについて実行されます。

-exportdirectory 必須 分析結果が入るディレクトリーへの完全修飾パス
-verbose オプション パラメーターを取らずに、すべての結果を stdout に書き出します
-directory 必須 (ソース・コードが既存の Eclipse ワークスペース内にない場合) Java プロジェクトのソース・フォルダーへの完全修飾パス。

まだ Eclipse ワークスペースで開いていない Java ソース・コードを分析する場合には、このオプションを使用してください。この場合、-data オプションで指定した新規ワークスペースで分析を実行すると、さらに効率が高くなります。

-data オプションを指定すると、com.ibm.xtools.analysis.commandline.temp という一時プロジェクトが作成され、また、-directory オプションで指定したディレクトリーにリンクするソース・ディレクトリーが作成されます。

-includeFile オプション 分析対象に含めるソース・コード・ファイルをリストするテキスト・ファイルへの完全修飾パス

このオプションを指定すると、-directory オプションで指定したロケーション内のソース・コード・ファイルを細かく制御することができます。テキスト・ファイルには、分析対象に含めるソース・コード・ファイルの行区切りリストを含める必要があります。 テキスト・ファイルでリストするパスは、完全修飾パスではなく、ソース・フォルダーを基準とする相対パスでなければなりません。

-excludeFile オプション 分析対象から除外するソース・コード・ファイルをリストするテキスト・ファイルへの完全修飾パス

このオプションを指定すると、-directory オプションで指定したロケーション内のソース・コード・ファイルを細かく制御することができます。テキスト・ファイルには、分析対象から除外するソース・コード・ファイルの行区切りリストを含める必要があります。 テキスト・ファイルでリストするパスは、完全修飾パスではなく、ソース・フォルダーを基準とする相対パスでなければなりません。

サンプル

次のサンプル命令は、Java ランチャーを使用してコード・レビュー分析を実行します。
c:¥ibmj9_50¥jre¥bin¥java.exe -cp C:¥progra~1¥IBM¥SDP70¥startup.jar org.eclipse.core.launcher.Main
-data "C:¥Documents and Settings¥default user¥IBM¥rationalsdp7.0¥workspace-rsa-en"
-application com.ibm.xtools.analysis.commandline.AnalyzeApplication
-rulefile c:¥temp¥commlinecoderev.dat -projects hello.world1 -exportdirectory c:¥temp
-verbose

フィードバック