自動コメントツール

自動コメントツールでは、ソースコード内のエンティティに有効な Javadoc コメントがあるかどうかを確認し、必要に応じてコメントを作成 (または編集) できます。エクスプローラから自動コメントツールを開くには、ドキュメントを作成するソースファイルをマウスの右ボタンでクリックし、「ツール」 「自動コメント」を選択します。

Javadoc コメントの状態

Javadoc コメントを持つソースコード内エンティティが、「自動コメントツール」の左側に表示されます。各エンティティに 2 つのアイコンが付いています。最初のアイコンは、Javadoc コメントの状態を示します。

有効な Javadoc コメント
不完全またはエラーのある Javadoc コメント
Javadoc コメントなし

2 番目のアイコンは、エンティティのアクセスレベルを示します。

公開 (public)
パッケージ (package)
限定公開 (protected)
非公開 (private)
エンティティを選択すると、そのエンティティに関するその他の情報が表示されます。エンティティに Javadoc コメントが存在しないか、または正しくない場合、次のようにコマンドボタンをクリックしてコメントを編集できます。

自動修正 コメント内のタグエラーを自動的に修正します。
ソースを表示 ソースエディタでファイルを開き、選択したエンティティに挿入ポイントを配置します。
再表示 ソースファイルに対する変更内容 (ソースエディタなどで加えられたもの) を反映して自動コメントツールの表示を更新します。

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 コメントの「プロパティエディタ」ダイアログでは、コメントを示す /** および */ や行頭のアスタリスクを入力する必要はありません。IDE がコメントとソースコードに追加する際に、これらの文字は自動的に含まれます。

タグ

Javadoc コメントのテキストのタグは、「自動コメントツール」の「タグ」パネルで作成して編集できます。Javadoc タグは、先頭文字 @ とそれに続く特殊なキーワードです。タグでは大文字と小文字が区別されます。Javadoc タグによって、API ドキュメントの情報を自動的に生成できます。たとえば、@author 名前 というタグは、生成されるドキュメントに、指定した 名前 の author エントリを追加します。タグは行頭になければなりません。行頭以外の場所にある場合は、通常のテキストとして処理されます。慣例として、同じ名前のタグはまとめて書きます。次のコメントには、4 つの Javadoc タグが含まれています。

/**
* A class representing a screen window.
* For example:
*    Window win = new Window(parent);
*    win.show();
*
* @author  Haley J. Ryan
* @version 1.3 00/08/08
* @see     java.awt.BaseWindow
* @see     java.awt.Button */

Javadoc タグをコメントに追加するには、「新規」をクリックし、Javadoc タグを選択するか新規タグを入力し、「了解」をクリックします。Javadoc コメントの「プロパティエディタ」ダイアログの「タグ」区画にタグが追加されます。「説明」フィールドには、タグのテキストを入力します。テキストには、HTML 要素 (<B><I> など) および Javadoc インラインタグ {@link} を含めることもできます。

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

著作権と商標について