Javadoc コメントの書式

Java プログラム内のクラス、インタフェース、メソッド、コンストラクタ、フィールド宣言に対し、Javadoc コメントを含めることができます。Javadoc コメントは、ソースコード内で対象エンティティの直前に配置する必要があります。Javadoc コメントはソースエディタで直接入力できます。Javadoc コメントの内容や書式についてのヘルプ情報が必要な場合は、Javadoc コメントの「プロパティエディタ」ダイアログを使用してコメントを作成できます。

コメントは、文字 /** で始まり、*/ で終わり、説明とタグの 2 つの部分で構成されています。以下に例を示します。

/**

* This is a <doc> comment.

* @see java.lang.Object

*/

この説明は、宣言されているエンティティを要約したものです。テキスト部分には、書式設定のために HTML 要素 (<B><I> など) を入れることができます。見出し要素 (<h1><h2> など) は、Javadoc ツールで使用するために予約されています。

タグは、Javadoc ツールが処理できる特殊なキーワードであり、コメント内に配置されます。標準の Javadoc タグは @tag_name の書式で記述され、インラインタグは {@tag} のように中括弧で囲まれます。タグはいくつでも使用できます (タグには繰り返し使用できるものとできないものがあります)。タグの後に説明を記述することはできません。

Javadoc コメントの記述方法の詳細については、Sun Microsystems の Web ページ (

http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html) を参照してください。

Javadoc タグの詳細については、次の URL を参照してください。

http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html

関連項目
Javadoc ドキュメントの生成
ソースコードへの Javadoc コメントの追加

著作権と商標について