生成されたコード内への Javadoc コメントの組み込み

Javadoc コメントが組み込まれるようにするには、コードを通常どおり生成します。

このタスクについて

Javadoc コメント生成は、デフォルトで Java 開発者の IBM® Rational® Rhapsody® プロジェクトに 使用可能です。

生成されたコードには、モデル要素に指定済みの説明を基にした Javadoc コメントが表示されます。 また、操作に関するコメントにも、操作の引数に指定済みの説明が組み込まれます。

コード内にこのようなコメントが表示されない場合は、 使用している構成の「フィーチャー」ウィンドウを開いて、「設定」タブで 「JavaDoc コメントの生成」チェック・ボックスが選択されていることを確認してください。 このオプションが選択されていても、生成されたコードに Javadoc コメントが依然として 表示されない場合は、Javadoc コメントのトラブルシューティングに リストされた提案事項を確認してください。

これらの基本 Javadoc コメントの生成に加えて、Rational Rhapsody に 標準の Javadoc タグ (author、deprecated、return、see、since、version) が組み込まれるようにすることもできます。生成されたコードにこれらの Javadoc タグを組み込むには、以下の手順で行います。

手順

  1. 文書化するモデル要素の「フィーチャー」ウィンドウを開きます。
  2. タグ」タブに表示された各種のタグに値を指定して、Javadoc コンテンツを 追加します。
  3. このプロセスを、文書化する各モデル要素に対して繰り返します。
  4. コードを生成します。

タスクの結果

コードに Javadoc コメントが組み込まれたら、 標準の Javadoc プロセスを使用して Javadoc レポートを生成できます。


フィードバック