前のリリースからの Javadoc 情報の保持

IBM® Rational® モデリング製品の前のリリースで生成された Javadoc タグの間の情報を保持するには、Java から UML への変換を 1 回のみ実行し、Javadoc 情報を UML モデルの対応する要素の文書プロパティーにマイグレーションします。
前のリリースでは、Java™ コード要素の Javadoc 情報は、以下のタグの間に含まれていました。
/**
 * <!-- begin-user-doc -->
 * <!-- end-user-doc -->
 */
UML から Java への変換を実行したとき、これらのタグの間のコメントは保護されました。 これらのタグは以下の Javadoc タグに置き換えられました。
/*
 * <!-- begin-UML-doc -->
 * <!-- end-UML-doc -->
 */
前のリリースで生成された Javadoc タグの間の情報を保持するには、Java から UML への変換を 1 回のみ実行し、Javadoc 情報を UML モデルの対応する要素の文書プロパティーにマイグレーションします。
次に UML から Java への変換を実行すると、以下のイベントが発生します。
  • @generated タグを含むコード要素に対して、UML から Java への変換によって、元の Javadoc タグが新規 Javadoc タグに置き換わります。タグの間の情報は、Java コードと UML モデルの間で同期されます。
  • @generated タグを含まないコード要素に対して、モデルの文書プロパティーへの更新は、Java コードに伝搬されません。
    注: 以下の例のように、@generated タグを該当する Java コード要素に追加することで、Javadoc 情報と UML 文書プロパティーの同期を使用可能にできます。
    /**
     *<!-- begin-UML-doc -->
     *<!-- end-UML-doc -->
     *@generated
     */
注: 前のリリースで生成された Javadoc タグを生成するために、Java 開発ツールキットのコード・テンプレートを変更することができます。コード・テンプレートを編集して、Javadoc 情報と UML モデル文書を別々に保持することができます。 コード・テンプレートを編集するには、「ウィンドウ」 > 「設定」 > 「Java」 > 「コード・スタイル」 > 「コード・テンプレート」 > 「コメント」とクリックします。以下のリストの各項目に対して、「編集」をクリックして、「テンプレートの編集」ウィンドウで、元の Javadoc タグをコード・コメントに追加します。
  • タイプ
  • フィールド
  • コンストラクター
  • メソッド
  • Getter
  • Setter
「コード・テンプレート」ウィンドウでコード・テンプレートを編集した後、「適用」 > 「OK」とクリックします。 以下のコード・フラグメントは、更新されたタイプのコード・テンプレートを表しています。
/**
 * @author $(user)
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
 * $(tags)
 */
編集する各コード・テンプレートに対して、次に UML から Java への変換を実行する際に、以下の例のように Javadoc タグの両タイプが生成されます。
/**
* <!-- begin-UML-doc -->
* Comments between these tags are synchronized between the UML model and generated Java code.
* <!-- end-UML-doc -->
* <!-- begin-user-doc -->
* Comments between these tags appear only in the code.
* <!-- end-user-doc -->
* @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
	 */
関連概念
Java から UML への変換
関連資料
Java から UML への変換によるソース・コードの変換処理

フィードバック