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