Javadoc コメントの「プロパティエディタ」ダイアログを使用し、ソースコード内のドキュメント化するコメントを追加または編集できます。「プロパティ」タブで「Javadoc コメント」プロパティの省略記号「...」ボタンをクリックし、特定のクラスの「プロパティエディタ」ダイアログを開きます。Javadoc コメントは、テキストとタグで構成されます。
コメントの最初の文は、宣言するエンティティの説明の要約でなければなりません。テキストには、説明の書式設定用の HTML 要素 (<B>
や <I>
など) を含めることもできます。見出し要素 (<H1>
や <H2>
など) は、Javadoc で使用するために予約されています。ダイアログの下部にあるコマンドボタンを使用し、説明に HTML 要素 (<B>
、<I>
、<U>
、<CODE>
、<PRE>
) および Javadoc {@link}
を挿入できます。以下に例を示します。
/** * Returns the Class of this <I>Object</I>. * Java has a runtime representation for * classes--a descriptor of type Class-- * which the method getClass() returns for * any Object. */
Javadoc コメントの「プロパティエディタ」ダイアログでは、コメントを示す /**
および */
や行頭のアスタリスクを入力する必要はありません。「了解」をクリックすると、これらの文字が自動的に付加され、ソースコードにコメントが追加されます。
Javadoc タグは、先頭文字 @
とそれに続く特殊なキーワードです。タグでは大文字と小文字が区別されます。Javadoc タグによって、API ドキュメントの情報を自動的に生成できます。たとえば、@author
name というタグは、生成されたドキュメントに、指定された名前の author エントリを追加します。タグは行頭になければなりません。行頭以外の場所にある場合は、通常のテキストとして処理されます。慣例として、同じ名前のタグはまとめて書きます。次のコメントには、4 つの Javadoc タグが含まれています。
/** * A class representing a screen window. * For example: * Window win = new Window(parent); * win.show(); * * @author Lynne Haley * @version 1.3 00/08/08 * @see java.awt.BaseWindow * @see java.awt.Button */
Javadoc タグをコメントに追加するには、Javadoc コメントの「プロパティエディタ」ダイアログで「新規」をクリックし、Javadoc タグを選択するか新規タグを入力し、「了解」をクリックします。「説明」フィールドには、タグのテキストを入力します。テキストには、HTML 要素 (<B>
や <I>
など) および Javadoc インラインタグ {@link}
を含めることもできます。
Javadoc コメントを記述する方法の詳細については、Sun Microsystems の Web ページ http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html
を参照してください。Javadoc タグの詳細については、 http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html
を参照してください。
関連項目 | |
---|---|
ソースコードへの Javadoc コメントの追加 |