Linux および Windows 用のコード・レビュー・アプリケーション・コマンドのパラメーター

コード・レビュー・アプリケーション・コマンドを実行する場合、ワークスペース、ソース・コード・ファイルがあるプロジェクトまたはディレクトリー、規則ファイルおよび出力ファイルのパスなどのパラメーターを指定します。

表 1 に、コード・レビュー・アプリケーションのアプリケーション・パラメーターを示します。

表 1. コード・レビュー・アプリケーションのパラメーター
パラメーター タイプ 説明
-application 必須 com.ibm.rsaz.analysis.commandline.AnalyzeApplication

このパラメーターは、コード・レビュー・アプリケーションの Eclipse アプリケーション ID を指定する場合に使用します。次に示すとおり、ID を正確に指定してください: com.ibm.rsaz.analysis.commandline.AnalyzeApplication

-data 必須 このパラメーターは、コード・レビュー・アプリケーションが使用する Eclipse ワークスペースのパスを指定します。 完全修飾パスでなければなりません。指定したワークスペースが存在しない場合は、作成されます。

-projects パラメーターも使用する場合、コード・レビュー・アプリケーションは指定されたプロジェクトをそのワークスペースで探します。

-projects パラメーターも -directory パラメーターも指定しない場合、コード・レビュー・アプリケーションは指定されたワークスペース内のすべてのプロジェクトを分析します。

-rulefile 必須 このパラメーターは、コード・レビュー規則セットとそれらの規則に割り当てられた重大度が入っている規則ファイルの完全修飾パスを指定します。 コード・レビュー・アプリケーションは、アプリケーションの開始時に指定されたプロジェクトまたはファイルにこれらの規則を適用します。

COBOL の場合は、カスタムのカテゴリーと規則、およびユーザー作成のカスタム規則を規則に含めることができます。

COBOL および Java™ の規則を、同じ規則ファイルに含めることができます。 処理の際に、コード・レビュー・アプリケーションは検出した各ソース・コード・ファイルのプログラミング言語を判別し、その言語に適用できる規則をそのファイルに適用します。

規則ファイルの拡張子は .dat でなければなりません。このファイルは、開始される eclipse.exe ファイルがインストールされているワークステーションのファイル・システムになければなりません。このファイルには、ネットワークを通じてアクセスすることも、イントラネットやインターネットを通じてアクセスすることもできません。

規則ファイルを作成するには、「エクスポート」をクリックして、選択した規則を分析構成エディターからエクスポートします。

-projects
-directory

オプション この 2 つのパラメーターは、分析するソース・コード・ファイルのロケーションを指定します。 -includefile パラメーターおよび -excludefile パラメーターを使用して、特定のファイルを含めたり除外したりすることもできます。

-data パラメーターで指定するワークスペース内のプロジェクトにソース・コード・ファイルがあるときは、-projects を使用します。

-data パラメーターで指定するワークスペース外のディレクトリーにソース・コード・ファイルがあるときは、-directory を使用します。

-projects-directory も指定しない場合、コード・レビュー・アプリケーションは指定されたワークスペース内のすべてのプロジェクトのソース・コード・ファイルを分析します。

-projects P1[, P2, P3 ...] を指定した場合、アプリケーションはプロジェクトのコンマ区切りリスト P1, P2, P3..... に含まれるすべてのソース・コード・ファイルを処理します。

-directory D1[, D2, D3, ...] を指定した場合、アプリケーションはディレクトリーのコンマ区切りリスト D1, D2, D3, .... に含まれるすべてのソース・コード・ファイルを処理します。

-projects-directory の両方を指定した場合、アプリケーションは -projects パラメーターを処理し、-directory パラメーターは無視します。

-directory パラメーターで作成された一時プロジェクト: 以下の説明は、-data パラメーターで指定されたワークスペース外にあるディレクトリーに適用されます。

-directory パラメーターの使用には、2 つの作用があります。
  • -directory パラメーターに指定されたディレクトリーごとに、同じ名前と genericProject_ または analyzedAsJava_ などの接頭部の付いた一時プロジェクトが -data パラメーターに指定されたワークスペースに作成されます。例えば、ディレクトリー c:\SourceFiles\CobolDirectory_0001-directory パラメーターに指定される場合には、genericProject_CobolDirectory_0001 などの一時プロジェクトがワークスペースに作成されます。各一時プロジェクトは、ローカル・ファイル・システムの対応する元のディレクトリーにリンクされる、Eclipse のリンクされたリソースです。
    ワークスペースからこれらの一時プロジェクトを削除できます。
    重要: ファイル・システムの対応するディレクトリーの内容が削除されないように、リソース・リンクを削除するための手順に従ってください。一時プロジェクトの削除について詳しくは、-directory パラメーターによって作成された一時プロジェクトの削除を参照してください。
  • CSV 分析結果ファイルおよび XML 分析結果ファイル内のディレクトリー・パスに、一時プロジェクトの名前が含まれます。
    注: 他のアプリケーションへの入力として結果ファイルを使用する前に、これらのパスを変更する必要がある場合があります。
注意:
-data パラメーターで指定するワークスペース内にあるディレクトリーを指定するには、-directory オプションを使用しないでください。これを行うと、指定されたディレクトリーにリンクされた Eclipse のリンクされたリソースである一時プロジェクトがワークスペースに作成されます。一時プロジェクトが正しく削除されないと、元のプロジェクト、フォルダー、またはソース・コード・ファイルが削除される可能性があります。一時ディレクトリーの削除については、『-directory パラメーターによって作成された一時プロジェクトの削除』を参照してください。
-includefile オプション このパラメーターは、-directory パラメーターが存在するときだけ使用されます。分析するソース・コード・ファイルのリスト (1 行に 1 ファイル) が入っているテキスト・ファイルの完全修飾パスを指定します。

-directory パラメーターと -includefile パラメーターの両方が存在する場合、コード・レビュー・アプリケーションは、包含ファイルで指定されていて、かつ、-directory パラメーターで指定されたいずれかのディレクトリーにあるソース・コード・ファイルのみを分析します。

包含ファイル内の各エントリーは、ファイル名か、相対パスにファイル名を付加したものでなければなりません。コード・レビュー・アプリケーションは、指定されたディレクトリーのそれぞれで、各エントリーを探します。

-excludefile オプション このパラメーターは、-directory パラメーターが存在するときだけ使用されます。分析から除外するソース・コード・ファイルのリスト (1 行に 1 ファイル) が入っているテキスト・ファイルの完全修飾パスを指定します。

-directory パラメーターと -excludefile パラメーターの両方が存在する場合、コード・レビュー・アプリケーションは、除外ファイルで指定されていて、-directory パラメーターで指定されたいずれかのディレクトリーにあるソース・コード・ファイルを分析から除外します。除外されないすべてのファイルが分析されます。

除外ファイル内の各エントリーは、ファイル名か、相対パスにファイル名を付加したものでなければなりません。コード・レビュー・アプリケーションは、指定されたディレクトリーのそれぞれで各エントリーを探し、ファイルが見つかった場合はそのファイルを除外します

-exportdirectory 必須 このパラメーターは、コード・レビュー・アプリケーションがその XML および CSV の出力データ・ファイルを書き込むディレクトリーの完全修飾パスを指定します。これらのデータ・ファイルを他のアプリケーションの入力として使用することができます。

出力データ・ファイルとしてサポートされるすべてのタイプが生成されます。

このパラメーターを省略した場合、出力データ・ファイルは生成されません。ただし、アプリケーションは標準出力に出力情報を書き込みます (そのオプションが指定されている場合)。

-nosplash オプション このパラメーターは、Eclipse スプラッシュ画面の表示を抑止します。

-verbose オプション このパラメーターは、コード・レビュー・アプリケーションが出力情報を標準出力に書き込むようにします。
Windows オペレーティング・システムの場合、出力情報を取り込むには、-verbose パラメーターを指定するだけでなく、次のようにコマンド行で標準出力をファイルにリダイレクトする必要もあります。
-verbose >output_file
>output_file オプション このリダイレクトをコマンド行で使用して、アプリケーション出力情報をファイルに取り込みます。

Windows の場合、出力情報を取得するためには、同時に -verbose パラメーターを指定する必要があります。


フィードバック