ソースコードへの Javadoc コメントの追加

Javadoc コメントはソースエディタで直接入力できます。Javadoc コメントの内容や書式についてのヘルプ情報が必要な場合は、Javadoc コメントの「プロパティエディタ」ダイアログを使用してコメントを作成できます。

ソースエディタを使用してコメントを追加する手順は、次のとおりです。

  1. ドキュメントを作成するクラス、インタフェース、コンストラクタ、メソッド、フィールドのいずれか宣言の直前に挿入ポイントを置きます。
  2. 正しい Javadoc 書式でコメントを入力します。
  3. ソースエディタで変更内容を保存します。

「自動コメントツール」ダイアログを使用してコメントを追加する手順は、次のとおりです。

  1. エクスプローラの「ファイルシステム」タブで、ドキュメントを作成する対象であるソースファイルをマウスの右ボタンでクリックし、「ツール」 「自動コメント」を選択します。

    「自動コメントツール」ダイアログが開き、ソースコードに含まれているクラス、インタフェース、およびその他のエンティティと、その Javadoc の状態 ( は有効な Javadoc コメント、 は不完全またはエラーのあるコメント、 はコメントがないことをそれぞれ示す) が表示されます。

  2. 「自動コメントツール」ダイアログで、コメントを作成または編集する対象のエンティティを選択します。
  3. コメントを変更するには、次のパネルを使用します。
    詳細 コメントが有効であるかどうかを示し、有効でない場合はその Javadoc コメントに何が欠けているかについて、情報を提供します。
    Javadoc コメントテキスト コメント記述を変更するためのテキストフィールドです。ダイアログの下部には、テキストの書式設定用の HTML 要素 (<B><I><U><CODE><PRE>) および Javadoc タグ {@link} を挿入するためのコマンドボタンがあります。
    タグ 選択して編集できるコメント内の既存タグのリストが表示されます。新しいタグを作成するには、「新規」クリックします。
  4. ダイアログボックスを閉じます。

    変更内容がソースファイルに保存されます。

Javadoc タグの詳細については、Sun Microsystems の Web ページ
http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html を参照してください。Javadoc コメントを記述する方法の詳細については、
http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html を参照してください。

関連項目
Javadoc コメントの書式
Javadoc ドキュメントの生成

著作権と商標について