ユーザー作成カスタム規則のプラグイン・プロジェクトを生成する

ユーザー作成カスタム規則のプラグイン・プロジェクトを生成するには、「新規プラグイン・プロジェクト」ウィザードの「COBOL 規則テンプレート」ページを使用します。

プロジェクトを生成する

手順

  1. プラグイン開発」パースペクティブを開きます。
  2. ワークベンチのメインメニューで、「ファイル」 > 「新規作成」 > 「プロジェクト」 > 「プラグイン開発」 > 「プラグイン・プロジェクト」とクリックして、「次へ」をクリックします。 「新規プラグイン・プロジェクト (New Plug-in Project)」ウィザードが開きます。
  3. 「プラグイン・プロジェクト」ページの「プロジェクト名」フィールドに新規プロジェクトの名前を入力して、「次へ」をクリックします。
  4. 「コンテンツ」ページの「ID」フィールドに新規プロジェクトの ID を入力して、「次へ」をクリックします。
  5. 「テンプレート」ページで「以下のテンプレートを使用してプラグインを作成」を選択してから、「カスタム COBOL コード・レビュー規則」を選択して、「次へ」をクリックします。
  6. 「COBOL 規則テンプレート」ページで、以下のフィールドに入力します。
    規則クラス
    完全修飾 Java クラス名を入力します。 ウィザードは、この名前を、新しい規則を実装するために作成するクラスに割り当てます。 このフィールドのデフォルト値は、プロジェクト ID の後に CobolRule という文字ストリングが続く値です。
    ヒント: プロジェクト ID は、ウィザードの「コンテンツ」ページの「ID」フィールドに指定した文字ストリングです。
    規則ラベル
    新しい規則の名前を入力します。 この名前は、分析構成エディターに表示される使用可能な規則のリストに追加されます。 このフィールドのデフォルト値は、「My custom COBOL rule」です。
    注: この名前は変換可能です。プラグイン内のストリングの国際化については、規則ラベルまたはカテゴリー名の国際化を参照してください。
    カテゴリー
    新しい規則の規則カテゴリーを作成するか、または新しい規則を既存の組み込み規則カテゴリーまたはカスタム規則カテゴリーに追加することができます。
    • 新しい規則を新しい規則カテゴリーに配置する場合は、「新規カテゴリーの作成」をクリックして、新しいカテゴリーのカテゴリー ID およびカテゴリー名を入力します。
    • 規則を既存のカテゴリーに追加する場合は、「既存のカテゴリーの選択」をクリックしてから、リストを展開し、新しい規則を追加するカテゴリーを選択します。
    カテゴリー ID
    カテゴリーの有効な Eclipse ID を入力します。分析構成エディターではこの ID 内にユーザー作成カスタム規則が表示されます。デフォルト値は、プロジェクト ID の後に custom という語が続く値です。
    ヒント: プロジェクト ID は、ウィザードの「コンテンツ」ページの「ID」フィールドに指定した文字ストリングです。
    カテゴリー名
    カテゴリーの名前を入力します。分析構成エディターではこのカテゴリー名の中にユーザー作成カスタム規則が表示されます。デフォルト値は Custom です。
    注: この名前は変換可能です。プラグイン内のストリングの国際化については、規則ラベルまたはカテゴリー名の国際化を参照してください。
  7. 「プログラム」ツリーを展開して、COBOL 言語エレメント、または新しい規則の実装コードが違反をチェックする必要があるエレメントを選択します。 デフォルトでは、エレメントは何も選択されていません。 選択されたエレメント用に生成された Java コードの例については、生成されたファイル: 実装コードを参照してください。
  8. 「完了」をクリックします。 ウィザードは、新規ユーザー作成カスタム規則のプラグイン・プロジェクトを作成してパッケージ・エクスプローラー・ビューに追加し、プラグイン・マニフェスト・エディターでマニフェスト・ファイルを開きます。
  9. 「プラグイン開発」パースペクティブをまだ開いていない場合は、プロンプトが表示されたときに開きます。
  10. プラグイン・マニフェスト・エディターを閉じます。

タスクの結果

「COBOL 規則テンプレート」ウィザードは、カスタム規則プラグイン・プロジェクト用に生成される plugin.xml ファイルに、規則およびカテゴリーの拡張を追加します。これらの拡張の詳細については、生成されたファイル: 規則およびカテゴリーの拡張を参照してください。

ウィザードは、ユーザー作成カスタム規則を実装するための Java クラスも生成します。このクラスの詳細については、生成されたファイル: 実装コードを参照してください。

規則ラベルまたはカテゴリー名の国際化

このタスクについて

プラグインをさまざまな言語に翻訳できるようにする必要がある場合は、翻訳可能なストリングを国際化できます。規則ラベルやカテゴリー名などのストリングの国際化の方法の説明は、Internationalize plug-in manifest にあります。以下に、手順の主なステップを説明します。

手順

  1. plugin.xml で作成された規則拡張で、文字ストリングの代わりに %variable を使用します。 例えば、規則ラベルで、変数 %myRuleLabel を次のように置換することができます。
    <analysisRule
          category="category_id"
          class="rule_class"
          id="rule_class"
          label="%myRuleLabel"
          severity="1">
    </analysisRule>
  2. plugin.properties ファイルで変数を定義します。 例:%myRuleLabel="My Rule Label"
  3. プロジェクトを通常のとおりビルドします。

フィードバック