Javadoc タグの追加

Javadoc 生成メカニズムを使用すると、使用したい新規の Javadoc タグを定義することができます。

このタスクについて

Javadoc タグを定義するには、次の手順で行います。

手順

  1. 「ファイル」 > 「モデルへの追加」を選択して、書き込み可能な JavaDocProfile プロファイルを作成し、<Rational Rhapsody installation path>¥Share¥
    Profiles¥JavaDoc¥JavaDocProfile.sbs
    ファイルを選択 (プロファイルがモデル内に存在していることを、製品が示している場合は、「Replace Existing Unit」オプションを選択) します。
  2. プロファイル内に Javadoc タグを作成します。このタグを作成する場合、「適用可能」リストから、適切な項目を選択してください。
  3. 関連タイプの要素にあわせて、DescriptionTemplate プロパティーの値を変更します。$<tagname> を使用して、製品の Javadoc コメントにタグ・テキストを含めます。
  4. 関連タイプの特定エレメントの「フィーチャー」ウィンドウを開き、「タグ」タブで、追加した新規 Javadoc タグの値を指定します。

手順

  1. プロファイルの下に、codeReviewer という名前の新規タグを作成します。「適用可能」リストで、「クラス」を選択します。
  2. JAVA_CG::Class::DescriptionTemplate プロパティーで、プロパティー値に以下を追加します: [[ * @codeReviewer $codeReviewer]]
  3. モデル内のクラス (複数可) に対して、「フィーチャー」ウィンドウを開き、「タグ」タブで、タグ codeReviewer の値として、Steve と入力します。

タスクの結果

上記の変更後、モデルに対してコードを生成すると、それらのクラスの Javadoc コメントに @codeReviewer Steve が含まれます。


フィードバック