本製品の前のリリースの Javadoc 情報の保持

前のリリースの IBM® Rational® Software Architectで生成された Javadoc タグ間の情報を保持するには、Java から UML への変換を一回実行して、 Javadoc 情報を、UML モデルの対応する要素の文書プロパティーにマイグレーションします。

このタスクについて

以前のリリースでは、Java™ コード要素の Javadoc 情報は、次のタグの間に含まれていました。

/**
 * <!-- begin-user-doc -->
 * <!-- end-user-doc -->
 */

これらのタグの間のコメントは、UML から Java 変換の実行時に保護されていました。これらのタグは、次の Javadoc タグに置換されました。

/*
 * <!-- begin-UML-doc -->
 * <!-- end-UML-doc -->
 */

手順

本製品の前のリリースで生成された Javadoc タグ間の情報を保持するためには、Java から UML への変換を一回実行して、 Javadoc 情報を、UML モデルの対応する要素の文書プロパティーにマイグレーションします。
次回、UML から Java 変換を実行すると、以下のイベントが発生します。
- @generated タグが含まれるコード要素では、UML から Java への変換により、オリジナルの Javadoc タグが新規の Javadoc タグに置換されます。タグ間の情報は、Java コードと UML モデルとで同期化されます。
- @generated タグが含まれないコード要素については、モデルの文書プロパティーへの更新は、Java コードに伝搬されません。
  注: Javadoc 情報と UML 文書プロパティーの同期化を有効にするには、次の例のように、適切な Java コード要素に @generated タグを追加します。
```
/**
 *
 *
 *@generated
 */
```
本製品の前のリリースで生成された Javadoc タグを生成するには、Java Development Toolkit でコード・テンプレートを変更します。個々の Javadoc 情報と UML モデル文書とを保守するように、コード・テンプレートを編集することができます。コード・テンプレートを編集するには、「ウィンドウ」 > 「設定」 > 「Java」 > 「コード・スタイル」 > 「コード・テンプレート」 > 「コメント」とクリックします。次のリストの項目ごとに、「編集」をクリックしてから、「テンプレートの編集」ウィンドウで、オリジナルの Javadoc タグをコード・コメントに追加します。
- データ型
- フィールド
- コンストラクター
- メソッド
- Getter
- Setter
コード・テンプレートの編集後、「コード・テンプレート」ウィンドウで「適用」 > 「OK」とクリックします。次のコード・フラグメントは、更新されたデータ型のコード・テンプレートを示しています。
```
/**
 * @author $(user)
* 
* 
 * $(tags)
 */
```
UML から Java 変換を次回実行した際に、編集したコード・テンプレートごとに両方のタイプの Javadoc タグが生成されます (次の例を参照)。
```
/**
* 
* Comments between these tags are synchronized between the UML model and generated Java code.
* 
* 
* Comments between these tags appear only in the code.
* 
* @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
	 */
```