コマンド行からのコード・レビューの実行

ヘッドレス・ワークベンチ (開発環境向けの、ユーザー・インターフェースのないワークベンチ) では、コマンド行インターフェースからコード・レビューを実行することができます。ソース・コード上で実行されるコード・レビュー・ルールは、ユーザー・インターフェースで最後に使用されたものです。コード・レビューを一度も実行していない場合は、 「Java 設定 - コード・レビュー (Java preferences - Code Review)」ページのデフォルト設定 (即時コード・レビュー) が 実行されます。デフォルトでは、コード・レビューの実行後、 HTML レポートと JSML (JScrib Markup Language) レポートの 2 つのレポートが生成されます。これらは、 com.ibm.r2a.command.line.mode フォルダー内のワークスペースのメタデータ・フォルダーにあります。生成されるレポートのタイプと、コード・レビューの実行後にレポートが生成される場所を指定することができます。

注: コード・レビューをヘッドレス・モードで実行できるのは、ワークスペースの場合のみです。ワークスペースのサブセット (1 つ以上の特定のプロジェクトなど) を分析する場合は、そのプロジェクトを含むワークスペースを作成して、このワークスペース上でコード・レビューを実行してください。
コード・レビューをヘッドレス・モードで実行する前には、以下を確認してください。 開発環境は稼働中でなくてもかまいません。

ヘッドレス・モードのコード・レビューを同一のワークスペースで同時に複数実行することはできません。 また、Eclipse グラフィカル・ユーザー・インターフェースによってワークスペースがロックされている場合もヘッドレス・モードは使用できません。

注: Windows オペレーティング・システムの制限により、コマンド行モードの実行に使用される文字列 (C:¥path¥java.exe …) の長さは、 できるだけ短くする必要があります。長すぎると、文字列末尾のパラメーターがシステムによってカットされたり、失われたりすることがあります。 Windows ユーザーは、以下のベスト・プラクティスに従って最良の結果を得る必要があります。
  • PATH 変数にはできるだけ多くのパスを組み込む必要があります。例えば、Java のパスおよび JAR ファイルへのパス。
  • ワークスペースへのパスは、できるだけ短くする必要があります。例えば、C:¥workspace。
  • レポートが生成される場所のパスもできるだけ短くする必要があります。例えば、C:¥report。
ヘッドレス・ワークベンチでコード・レビューを実行するには、 次のコマンドを製品構成と共に使用して、コマンド行モードのアプリケーションを起動します。 <eclipse_dir>/jre/bin/java <virtual machine options> -cp <eclipse_dir>/startup.jar org.eclipse.core.launcher.Main <command line mode options> <eclipse options> 製品構成は、「ヘルプ」>「概要」>「構成詳細 (Configuration Details)」>「システム・プロパティー (System properties)」にあります。 <virtual machine options>eclipse.vmargs プロパティーにあります。主要な Eclipse オプションは eclipse.commands プロパティーにあります。このプロパティーには、Eclipse トークンの -data を使用してワークスペースのパスを追加します。 <command line mode options> はコマンド行モードのオプションを指します。
注: ご使用のオペレーティング・システム構成によって、次のステップのコマンドにパラメーターを追加する必要がある場合があります。これらのパラメーターは、"「システム・プロパティー (System properties)」"の下のシステム構成詳細にあります。
ヘッドレス・ワークベンチでコード・レビューを実行するには、以下のようにします。
  1. コマンド行ウィンドウまたはシェルを開きます。
    • Windows の場合は次のコマンドを入力します。<eclipse_dir>/jre/bin/java -Xj9 -Dorg.eclipse.swt.browser.internal.flash -Dorg.eclipse.emf.ecore.EPackage.Registry.INSTANCE=org.eclipse.emf.ecore.impl.EPackageRegistryImpl -cp <eclipse_dir>/startup.jar org.eclipse.core.launcher.Main -application com.ibm.r2a.command.line.mode.CommandLineModeApplication -plugincustomization <pluginCustomizationPath> -data <workspace_dir> -reportDirectory <your_report_directory> -onlyClient CodeReview
    • Linux の場合は、次のコマンドを入力します。<eclipse_dir>/jre/bin/java -Xj9 -Dorg.eclipse.swt.browser.internal.flash -Dorg.eclipse.emf.ecore.EPackage.Registry.INSTANCE=org.eclipse.emf.ecore.impl.EPackageRegistryImpl -cp <eclipse_dir>/startup.jar org.eclipse.core.launcher.Main -application com.ibm.r2a.command.line.mode.CommandLineModeApplication -os linux -ws gtk -plugincustomization <pluginCustomizationPath> -data <workspace_dir> -reportDirectory <your_report_directory> -onlyClient CodeReview
    <eclipse_dir> を、Eclipse ディレクトリーへのパスに置き換えます。この Eclipse ディレクトリーは、プロジェクトのルート・ディレクトリーにある Eclipse ディレクトリーでなければなりません。 <workspace_dir> を、ワークスペース・ディレクトリーへのパスに置き換えます。 <pluginCustomizationPath> を、pluginCustomization.ini ファイルのパスに置き換えます。 それ以外のオプションがあれば、コマンド行の最後に追加します。オプショナル・パラメーターについては、 コード・レビュー・ヘッドレス・モードの関連する参照トピックを参照してください。 上記コマンドの各部の意味は次のとおりです。
    • -Xj9 –Dorg.eclipse.swt.browser.internal.flash - Dorg.eclipse.emf.ecore.EPackage.Registry.INSTANCE=org.eclipse.emf.ecore.impl.EPackageRegistryImpl は、RASD 製品で必要な仮想マシン引数に相当します。
    • -data <workspace_dir> -plugincustomization <pluginCustomizationPath> は、 必要な Eclipse 引数に対応します。
    • 他の引数は、コマンド行モードのアプリケーションに関連しています。
    パスにスペースが含まれる場合、二重引用符を使用します。 Windows の場合は、円記号ではなく、二重円記号 (¥¥) を使用します。例: "C:¥¥Program Files¥¥IBM¥¥Rational¥¥"
  2. Enter キーを押します。
コード・レビューの結果は、ワークスペース内の report ディレクトリーに生成されます。
関連概念
ヘッドレス・モードで実行されるコード・レビュー
関連資料
コード・レビューのヘッドレス・モードのリファレンス
即時コード・レビュー
ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved. (C) Copyright IBM Japan 2005