「設定」ダイアログ - 「コード・エディタ」 - 「Java」 - 「JavaDoc」ページ
Javadocコメントのタグを設定する際に使用します。
Javadocタグとオプションの詳細は、http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/index.htmlにあるSolarisまたはMicrosoft Windowsの「Javadoc Tool Reference Page」を参照してください。
Javadocツール自体の詳細は、http://java.sun.com/j2se/javadoc/index.jspにある「Core Java」ページを参照してください。
- Javadocコメント・スタブの生成
- 次のオプションは、「Javaクラス作成」ダイアログを介して新規クラスを作成するときに適用されます。
- クラス
- JDeveloperで、すべてのクラス宣言のコードにdocコメント・スタブを自動挿入するよう指定する場合に選択します。デフォルトで選択されています。
- メソッド
- JDeveloperで、すべてのメソッド宣言のコードにdocコメント・スタブを自動挿入するよう指定する場合に選択します。デフォルトで選択されています。
- フィールド
- JDeveloperで、すべてのフィールド宣言のコードにdocコメント・スタブを自動挿入するよう指定する場合に選択します。デフォルトでは未選択です。
- 可視性付き
- コメントを自動追加するクラス、メソッド、フィールドのアクセス・レベルを選択します。
- タグ
- タグを選択し、右側のリストにプロパティを表示します。ビルトイン・タグの名前およびスコープ(必須以外のもの)は変更できません。
- タグのプロパティ
-
- 名前
- 「タグ」リストで選択されたタグの名前を表示します。新規のカスタムdocタグを作成するには、このフィールドを使用してタグの名前を入力します。
- 使用方法
- docタグが適用される要素を表示し、タグが必須かどうか示します。必須のビルトイン(標準)タグを再定義できます。他の属性は変更できません。
新規のカスタムdocタグを作成するときに、タグが適用される要素を選択し、タグが必須かどうか指定します。必須のタグは、新規クラスに自動追加されます。既存ファイルのJavadocコメントを監査するときに、必須と定義されているにもかかわらずファイルにないタグにはエラー・フラグが設定されます。
- テキスト
- タグについてのデフォルトの説明を表示します(存在する場合)。たとえば、authorタグと同様に、既存タグの一部に値を追加できます。
新規のカスタムdocタグを作成するとき、ここへデフォルトの説明を入力します。
- プレビュー
- エディタに表示されるとおりにタグを表示します。
- 追加
- 新規のJavadocタグを追加する場合にクリックします。「タグ」リスト中でタグはデフォルト名newとともに表示されます。「名前」フィールドでタグに名前を割り当て、このダイアログ中で他の属性を定義します。
- 削除
- 「タグ」リストで選択されたタグを削除する場合、クリックします。ビルトイン(標準)タグは削除できません。
-
- 選択されたタグの「タグ」リスト中の位置を上へ移動する場合、クリックします。ここで指定されたタグの順序がコード中のタグの順序と一致しない場合、Auditsにより警告が表示されます。デフォルトの順序は、Sun社により定義された順序です。
-
- 選択されたタグの「タグ」リスト中の位置を下へ移動する場合、クリックします。ここで指定されたタグの順序がコード中のタグの順序と一致しない場合、Auditsにより警告が表示されます。デフォルトの順序は、Sun社により定義された順序です。
関連項目
プロジェクトのJavadocプロパティの設定
プロジェクトのJavadocの生成
Copyright © 1997, 2004, Oracle. All rights reserved.