eclipse_directory¥eclipse | eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data workspace_directory
-rulefile rule_file
[-projects P1[, P2, P3, ...] |
-directory D1[, D2, D3, ...]]
[-includefile include_file]
[-excludefile exclude_file]
-exportdirectory export_directory
[-nosplash]
[-verbose]
[ >output_file]
それぞれの意味は次のとおりです。
eclipse_directory¥eclipse | eclipse.exe は、Eclipse 実行可能ファイルの完全修飾パスです。Linux の場合は eclipse、Windows の場合は eclipse.exe を使用します。
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication は、コード分析コンポーネントの名前です。
-data workspace_directory は、使用する Eclipse ワークスペースの完全修飾パスです。
-rulefile rule_file は、分析構成エディターからエクスポートした規則セットと重大度が入っている .dat ファイルの完全修飾パスです。
-projects P1[, P2, P3, ...] は、ソース・ファイルを含むワークスペース内プロジェクトのコンマ区切りリストです。
-directory D1[, D2, D3, ...] は、ソース・ファイルが入っているディレクトリーのコンマ区切りリストです。
-includefile include_file は、コード・レビューに含めるファイルのリストが入っているファイルです。
-excludefile exclude_file は、コード・レビューから除外するファイルのリストが入っているファイルです。
-exportdirectory export_directory は、出力データ・ファイルが書き込まれるディレクトリーの完全修飾パスです。
-nosplash は、Eclipse スプラッシュ画面の表示を抑止します。
-verbose は、出力情報が標準出力に書き込まれるようにします。
> output_file は、標準出力に書き込まれる出力情報を取り込むテキスト・ファイルです。
表 1 に、コード・レビュー・アプリケーションのアプリケーション・パラメーターを示します。
| ヘッダー | タイプ | 説明 |
|---|---|---|
| -application | 必須 | com.ibm.rsaz.analysis.commandline.AnalyzeApplication このパラメーターは、呼び出す Eclipse アプリケーションの ID を指定します。コード・レビュー・アプリケーションを識別するための上記テキスト・ストリングを使用してください。 |
| -data | 必須 | このパラメーターは、コード・レビュー・アプリケーションが使用する Eclipse ワークスペースのパスを指定します。
完全修飾パスでなければなりません。 指定したワークスペースが存在しない場合は、作成されます。 |
| -rulefile | 必須 | このパラメーターは、コード・レビュー規則セットとそれらの規則に割り当てられた重大度が入っている規則ファイルの完全修飾パスを指定します。
コード・レビュー・アプリケーションは、呼び出しで指定されたプロジェクトまたはファイルにこれらの規則を適用します。
COBOL の場合は、カスタムのカテゴリーと規則、およびユーザー作成のカスタム規則を規則に含めることができます。 |
-projects |
オプション | この 2 つのパラメーターは、分析するソース・コード・ファイルのロケーションを指定します。
(-includefile パラメーターおよび -excludefile パラメーターを使用して、特定のファイルを含めたり除外したりすることもできます。) 指定したワークスペース内のプロジェクトにソース・コード・ファイルがあるときは、-projects を使用します。 |
| -includefile | オプション | このパラメーターは、-directory パラメーターが存在するときだけ使用されます。分析するソース・コード・ファイルのリスト (1 行に 1 ファイル) が入っているテキスト・ファイルの完全修飾パスを指定します。 -directory パラメーターと -includefile パラメーターの両方が存在する場合、コード・レビュー・アプリケーションは、包含ファイルで指定されていて、かつ、-directory パラメーターで指定されたいずれかのディレクトリーにあるソース・コード・ファイルのみを分析します。 |
| -excludefile | オプション | このパラメーターは、-directory パラメーターが存在するときだけ使用されます。分析から除外するソース・コード・ファイルのリスト (1 行に 1 ファイル) が入っているテキスト・ファイルの完全修飾パスを指定します。 -directory パラメーターと -excludefile パラメーターの両方が存在する場合、コード・レビュー・アプリケーションは、除外ファイルで指定されていて、-directory パラメーターで指定されたいずれかのディレクトリーにあるソース・コード・ファイルを分析から除外します。除外されないすべてのファイルが分析されます。 |
| -exportdirectory | 必須 | このパラメーターは、コード・レビュー・アプリケーションがその XML および CSV の出力データ・ファイルを書き込むディレクトリーの完全修飾パスを指定します。これらのデータ・ファイルを他のアプリケーションの入力として使用することができます。 出力データ・ファイルとしてサポートされるすべてのタイプが生成されます。 |
| -nosplash | オプション | このパラメーターは、Eclipse スプラッシュ画面の表示を抑止します。 |
| -verbose | オプション | このパラメーターは、コード・レビュー・アプリケーションが出力情報を標準出力に書き込むようにします。 注: Windows オペレーティング・システムの場合、出力情報を取り込むには、-verbose パラメーターを指定するだけでなく、次のようにコマンド行で標準出力をファイルにリダイレクトする必要もあります。
|
| >output_file | オプション | このリダイレクトをコマンド行で使用して、アプリケーション出力情報をファイルに取り込みます。 Windows の場合、出力情報を取得するためには、同時に -verbose パラメーターを指定する必要があります。 |
これらのサンプル呼び出しは、コード・レビュー・アプリケーションを呼び出す方法の例を示したものです。 Linux または Windows のコマンド行で、呼び出しを 1 行に入力してください。
C:\progra~1\IBM\SDP\eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data "C:\RDz 85 workspaces\workspace_851_0914"
-rulefile "C:\RDz 8.5\CodeQuality\results\cobolRules.dat"
-projects "My COBOL project 0001","My COBOL project 0002"
-exportdirectory "C:\RDz 8.5\CodeQuality\CommandlineResults\Results851"
-nosplash
-verbose > c:\commandlineResults\out851_0916_COBOLProjects.txt
C:\progra~1\IBM\SDP\eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data "C:\RDz 85 workspaces\workspace_851_0914"
-rulefile "C:\RDz 8.5\CodeQuality\results\PL1Rules.dat"
-directory "C:\CheckSourceCode\PL1_Files_0001"
-excludefile "C:\RDz 8.5\CodeQuality\directoryExcludeFiles.txt"
-exportdirectory "C:\RDz 8.5\CodeQuality\CommandlineResults\Results851"
-nosplash
-verbose > c:\commandlineResults\out851_0916_PL1Projects.txt
20121008_101746
出力情報とは、コード・レビュー・アプリケーションが標準出力に書き込む情報のことです。 この情報には、レポート・リンク、結果のリスト、および結果カウントが含まれます。
[url]http://server:9090/rsar/reports/20121004_162226/[/url]
結果のリストには各規則が 1 つずつ示され、それぞれの後にその規則が適用されたソース・コード・ファイルと行番号が続きます。
結果カウントは、リストされたすべての規則について、規則が適用された合計回数を示します。
製品ワークスペースにあるソース・コード・ファイルに対してコード・レビュー・アプリケーションを実行するときは、-directory パラメーターではなく、常に -projects パラメーターを使用することをお勧めします。