IDE の自動コメントツールを使用すると、ソースコードの Javadoc コメントが有効であるかどうかを確認し、必要に応じてコメントを編集または作成することができます。Javadoc コメントがあるソースコードエンティティーは、左区画とタグに一覧表示され、コメント自体は右区画に表示されます。
「プロジェクト」ウィンドウまたはソースエディタで、ドキュメントを作成するソースファイルを右クリックし、コンテキストメニューから「ツール」>「自動コメント」を選択します。
フィルタツールバーを使用すると、「自動コメント」ツールで表示するクラスとメンバーを制御できます。次の表では、ツールバー上に配置されたボタンについて説明します。
ツールバー ボタン |
説明 |
---|---|
![]() |
完全な形式の Javadoc コメントを持つクラスとメンバーの表示に切り替えます。 |
![]() |
断片的な Javadoc コメントまたは不完全な Javadoc コメントを持つクラスとメンバーの表示に切り替えます。 |
![]() |
Javadoc コメントを持たないクラスとメンバーの表示に切り替えます。 |
![]() |
public メソッドの表示に切り替えます。 |
![]() |
デフォルトアクセスを持つメソッドの表示に切り替えます。 |
![]() |
protected アクセス権を持つメソッドの表示に切り替えます。 |
![]() |
private メソッドの表示に切り替えます。 |
エンティティーが場所を特定できない Javadoc コメントまたは不適切な Javadoc コメントも持つ場合は、コマンドボタンをクリックしてコマンドを編集することができます。 次に、コマンドボタンの一覧を示します。
エンティティーが場所を特定できない Javadoc コメントまたは不適切な Javadoc コメントも持つ場合は、コマンドボタンをクリックしてコマンドを編集することができます。次に、コマンドボタンの一覧を示します。
public String myMethod(Object param1, Object param2){}この場合「自動修正」をクリックすると、Javadoc ウィンドウの「タグ」区画内、およびソースエディタに次のようなタグが生成されます。
@param param1 @param param2 @return
自動コメントツールの「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 name というタグは、生成されたドキュメントに、指定された名前の 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 タグを選択するか新規タグを入力し、「了解」をクリックします。そのタグが「タグ」区画に追加されます。「説明」フィールドには、タグのテキストを入力します。テキストには、HTML 要素の (<B> や <I> など) および Javadoc インラインタグ {@link} を含めることもできます。