「設定」ダイアログ - 「コード・エディタ」 - 「Java」 - JavaDocページ

ドキュメント・コメントのJavadocタグを設定する際に使用します。

Javadocタグとオプションの詳細は、http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.htmlにあるSolarisまたはMicrosoft WindowsのJavadoc Tool Referenceページを参照してください。

Javadocツール自体の詳細は、http://java.sun.com/j2se/javadoc/にあるCore Javaページを参照してください。

 
タグ

タグを選択し、右側にそのプロパティを表示します。リストの項目を並べ替えるには、シャトル・ボタンを使用します。

上矢印ボタン

選択されたタグの「タグ」リスト中の位置を上へ移動する場合、クリックします。ここで指定されたタグの順序がドキュメント・コメント内のタグの順序と一致しない場合、Auditsにより警告が表示されます。デフォルトの順序は、Sun社により定義された順序です。

下矢印ボタン

選択されたタグの「タグ」リスト中の位置を下へ移動する場合、クリックします。ここで指定されたタグの順序がドキュメント・コメント内のタグの順序と一致しない場合、Auditsにより警告が表示されます。デフォルトの順序は、Sun社により定義された順序です。

追加

新しいタグを定義してリストに追加する場合にクリックします。デフォルト名newのタグが表示されます。「タグのプロパティ」ボックスでタグに名前を割り当て、他のプロパティを設定します。

削除

選択されたタグを削除する場合にクリックします。標準タグは削除できません。

 
 
タグのプロパティ

「タグ」リストで選択されているタグのプロパティが表示されます。

名前

タグの新しい名前を入力します。標準タグの名前は変更できません。

使用方法

タグが適用されるコード要素(「フィールド」「メソッド」および「クラスとインタフェース」)を選択します。標準タグの適用は再定義できません。

必須

適用可能なコード要素に関してドキュメント・コメントが作成されたときにタグを追加する場合に選択します。既存のファイルのドキュメント・コメントを監査するときに、必須に定義されているとファイルにないタグにはエラー・フラグが立てられます。

 
 
 
 
テキスト

存在する場合、タグのデフォルトのテキストを入力します。タグの中には、paramのように、デフォルトのテキストがテンプレートになっており、ドキュメント・コメントの参照先のコード要素から取得された値で置き換えられるものがあります。

プレビュー

エディタに表示されるとおりにタグを表示します。

 

Javadocコード・エディタの設定
Javadocの実行