機械翻訳について

標準ドックレットのドキュメント・コメント仕様

このドキュメントでは、HTML APIドキュメントを生成するために使用される、javadocツールの標準ドックレットで認識されるドキュメント・コメントの形式を指定します。

javadocツールのコンテキストでは、ドキュメント・コメントのコンテンツの解釈は、コメントの処理に使用されるドックレットまでです。 他のドックレットは、標準ドックレットと同じ構文を受け入れるか、代替構文をサポートする場合があります。 ただし、多くのツールでのサポートにより、標準ドックレットでサポートされている構文は事実上の標準となっています。

一般的な構文

ドキュメント・コメントは、モジュール、パッケージ、クラス、インタフェース、コンストラクタ、メソッドまたはフィールド宣言の直前に配置された場合にのみ認識されます。 メソッドの本体に置かれているドキュメンテーション・コメントは無視されます。 宣言文ごとに1つのドキュメント・コメントのみが認識されます。

履歴上の理由から、パッケージのドキュメントコメントは、代わりにパッケージのソースディレクトリにある package.htmlというファイルに記述できます。 この場合、ドキュメント・コメントは<body>タグの内容であり、Java型(たとえば、@seeタグ内)へのすべての参照は完全修飾である必要があります。 標準ドックレットでは、追加のドキュメントをoverview.htmlなどのファイルに提供できます。 このようなコンテンツのルールは、package.htmlの場合と同じです。

ドキュメント・コメントの全体的な形式は、最初の(メイン)説明の後に、コメントが適用される宣言に関する追加情報を提供する一連のブロック・タグが続きます。 最初の説明の最初の文は、宣言されたエンティティの簡潔で完全な説明を含むサマリー文である必要があります。 記述テキストには、HTMLタグとエンティティ、および次に説明するインライン・タグを含めることができます。

タグ・セクションのみで、初期説明のないコメントを持つことができます。 タグ・セクションの開始後に説明を続行できません。 タグの引数は、複数行にわたって記述できます。 任意の数のタグが存在できます。一部のタイプのタグは繰り返すことができ、他のタグは繰り返すことができません。

行の先頭のアスタリスク

ドキュメント・コメントが読み取られると、各行の先頭のアスタリスク(*)は破棄され、最初のアスタリスク(*)の前の空白およびタブも破棄されます。 行の先頭のアスタリスクを省略すると、先頭の空白は削除されなくなり、インデントが保持された<pre>タグ内のドキュメント・コメントにコード例を直接貼り付けることができます。 ブラウザは、空白文字をタブよりも一律に解釈します。 インデントは、(セパレータ/**または<pre>タグではなく)左マージンに対して相対的です。

HTMLコンテンツ

HTMLコンテンツは正式にチェックされませんが、一部のツールでは、一般的なエラーをキャッチするために一定量のチェックが提供される場合があります。

メンバーのドキュメント・コメントを記述する場合は、<h1>や<h2>などのHTMLヘッダー・タグを使用しないことをお薦めします。これは、標準ドックレットによって構造化ドキュメント全体が作成され、これらの構造化タグによって生成されたドキュメントの書式設定が妨げられる可能性があるためです。

コメント継承

クラスとインタフェースの継承

クラスおよびインタフェースからの継承が行われる可能性のあるすべての場合に、コメントの継承が行われます。

最初の2つのケースでは、標準ドックレットは、オーバーライドするメソッドのドキュメントで"オーバーライド"という小見出しを生成します。 そのコメントが継承されているかどうかにかかわらず、オーバーライドされているメソッドへのリンクが書き込まれます。

3番目のケースでは、指定されたクラスのメソッドがインタフェースでメソッドを実装すると、標準のドックレットは、オーバーライドするメソッドのドキュメントで"指定された"という小見出しを生成します。 そのコメントが継承されているかどうかにかかわらず、実装されているメソッドへのリンクが書き込まれます。

メソッド・コメントの継承

標準ドックレットを使用すると、クラスおよびインタフェースでのメソッド・コメントの継承によって、欠落しているテキストを入力したり、メソッド・コメントを明示的に継承したりできます。 コンストラクタ、フィールド、およびネストされたクラスは、ドキュメンテーション・コメントを継承しません。

ノート: ドキュメンテーション・コメントを実際にコピーに利用するには、継承したメソッドのソース・ファイルが-sourcepathオプションで指定したパスに置かれていることが必要になります。 コマンド行で、クラスもパッケージも渡す必要はありません。

欠落テキストの入力

メイン記述または@return、@paramまたは@throwsタグがメソッド・コメントにない場合、その情報がオーバーライドまたは実装するメソッド(ある場合)からコピーされます。

特定のパラメータの@paramタグが見つからない場合、そのパラメータのコメントが、上位の継承階層のメソッドからコピーされます。 特定の例外の@throwsタグが見つからない場合、その例外が宣言されている場合にかぎり、その@throwsタグがコピーされます。

明示的な継承

メソッドの主説明または@return、@param、@throwsタグ・コメントに{@inheritDoc}インライン・タグを挿入します。 継承した対応する主説明またはタグ・コメントは、その箇所にコピーされます。

メソッド・コメントのアルゴリズム

メソッドにドキュメント・コメントがないか、{@inheritDoc}タグがある場合、標準ドックレットは、次のアルゴリズムを使用して適用可能なコメントを検索します。 このアルゴリズムは、もっとも限定的で適用可能なドキュメンテーション・コメントを検索するように設計されており、スーパー・クラスよりもインタフェースが優先されるようになっています。

  1. 直接に実装されている(または、拡張されている)インタフェースを、メソッドの宣言でimplements (またはextends)キーワードの後に出現する順序で、1つずつ調べます。 このメソッドについて最初に見つかったドキュメンテーション・コメントを採用します。
  2. ステップ1でドキュメンテーション・コメントが見つからなかった場合は、直接実装されている(または、拡張されている)インタフェースのそれぞれに対して、このアルゴリズム全体を再帰的に適用します(その際の順序は、ステップ1でインタフェースを調べたときの順序と同じ)。
  3. ステップ2でドキュメンテーション・コメントが見つからなかった場合で、このクラスがObject以外のクラスであるが、インタフェースではない場合は、次のように処理します。
    1. スーパー・クラスにこのメソッドについてのドキュメンテーション・コメントが記述されていれば、そのコメントを採用します。
    2. ステップ3aでドキュメンテーション・コメントが見つからなかった場合は、スーパー・クラスに対して、このアルゴリズム全体を再帰的に適用します。

標準タグ

次の項では、標準ドックレットでサポートされている標準ブロック・タグとインライン・タグについて説明します。

ノート: 標準ドックレットでは、同じ一般的な構文ルールに準拠したユーザー定義タグもサポートされます。

タグをブロック

ブロック・タグは、先頭のアスタリスク、空白および初期コメント・デリミタ(/**)を無視して、行の先頭に付ける必要があります。 これは、テキスト内のそれ以外の位置で@文字を使用しても、タグの開始としては解釈されないことを意味しています。 行の最初に@文字を使用してもタグとして解釈されないようにするには、HTMLエンティティの&#064;を使用してください。 各ブロック・タグにはテキストが関連付けられており、このテキストには、次のブロック・タグまたはドキュメンテーション・コメントの最後まで(含まない)タグの後に続くテキストが含まれます。 この関連テキストは複数行にわたって記述できます。

@author

-authorオプションを使用すると、指定された名前テキストを持つ"著者"エントリを生成されたドキュメントに追加します。 1つのドキュメンテーション・コメントに複数の@authorタグを含めることができます。 1つの@authorタグに1つの名前を指定することも、複数の名前を指定することもできます。 前のケースでは、標準ドックレットはカンマ(,)と名前の間にスペースを挿入します。 後者の場合は、テキスト全体が、解析されることなく、生成ドキュメントにコピーされます。 したがって、カンマではなく、各言語に対応した名前区切り文字を使う必要があるときは、1つのタグに複数の名前を指定してください。

JDK 1.0で導入

@deprecated

このタグは、@Deprecatedアノテーションと組み合せて使用され、このAPIは(引き続き動作していても)使用されなくなることを示します。 標準ドックレットは、非推奨のテキストをメインの説明より前に移動し、イタリック体に置き、その前に太字の警告を付けます。

deprecated-textの最初の文では、少なくとも、そのAPIが非推奨になった時期と、代替使用するべきAPIを読者に提示する必要があります。 標準ドックレットは、最初の文をサマリー・セクションおよび索引にコピーします。 その後の文では、それが非推奨になった理由を説明することもできます。 置換APIを指す{@link}タグを含める必要があります。

JDK 1.0で導入

@exception

このタグは、推奨される形式になった @throwsタグと同等です。

JDK 1.0で導入

@hidden

生成されたAPIドキュメントからプログラム要素を非表示にします。 このタグは、そのような項目がまったく表示されないようにAPIを設計することが他の方法では不可能である場合に使用できます。

JDK 9で導入

@param

"Parameters"セクションに、指定されたパラメータ名の後に指定された説明が続くパラメータを追加します。 摘要は複数の明細に継続できます。 このタグは、メソッド、コンストラクタ、またはクラスのドキュメンテーション・コメント内でのみ有効です。 パラメータ名には、メソッドまたはコンストラクタ内のパラメータの名前、またはクラス、メソッドまたはコンストラクタの型パラメータの名前を指定できます。 このようなパラメータ名の周囲に山カッコ(< >)を使用して、型パラメータの使用を示します。

クラスの型パラメータの例:

/**
 * @param <E> Type of element stored in a list
 */
public interface List<E> extends Collection<E> { ... }

メソッドの型パラメータを含むパラメータの例:

/**
 * @param string  the string to be converted
 * @param type    the type to convert the string to
 * @param <T>     the type of the element
 * @param <V>     the value of the element
 */
<T, V extends T> V convert(String string, Class<T> type) { ... }

JDK 1.0で導入

@provides

このタグは、モジュール宣言のドキュメンテーション・コメントにのみ表示され、モジュールによって提供されるサービスの実装を文書化するのに役立ちます。 この説明は、このサービス・プロバイダのインスタンスの取得方法およびプロバイダの重要な特性を指定するために使用できます。

JDK 9で導入

@return

説明テキストとともに"戻り値"セクションを追加します。 このテキストでは、戻り値の型と、取り得る値の範囲について記述する必要があります。 このタグは、メソッドのドキュメンテーション・コメントでのみ有効です。

JDK 1.0で導入

@see

"関連項目"見出しに、参照を指すリンクまたはテキスト・エントリを追加します。 1つのドキュメンテーション・コメントには、任意の数の@seeタグを指定できます。すべての@seeタグの内容は、同じ見出しの下にグループ化されます。 @seeタグには、3種類の形式があります。 他のプログラム要素を参照するフォームが最も一般的です。 このタグは、すべてのドキュメント・コメントで有効です。 文内のインライン・リンクをパッケージ、クラスまたはメンバーに挿入するには、{@link}を参照してください。

stringのテキスト・エントリを追加します。 リンクは生成されません。 文字列は、URLでは使用できない情報への参照である可能性があります。 標準ドックレットは、最初の文字として二重引用符(")を検索することで、これを他のケースと区別します。

urlで定義されたリンクを追加します。 URLは相対URLまたは絶対URLです。 標準ドックレットは、最初の文字としてより小さい記号(<)を検索することで、これを他のケースと区別します。

参照される指定された名前のドキュメントを指し示す表示可能なテキスト・ラベルのリンクを追加します。 ラベルはオプションです。ラベルを省略すると、プログラム要素名は表示テキストとして表示され、適切に短縮されます。 -noqualifierオプションを使用すると、表示テキストからパッケージ名が全体的に削除されます。 表示されるテキストを自動生成された表示テキストと異なる場合は、ラベルを使用します。

package.class#memberは、パッケージ、クラス、インタフェース、コンストラクタ、メソッドまたはフィールド名など、参照される任意の有効なプログラム要素名です。 名前の一部は、必要に応じて省略できます。 classは、トップレベルまたはネストされた、任意のクラスまたはインタフェースを表します。 memberは、任意のコンストラクタ、メソッドまたはフィールド(ネストされたクラスまたはインタフェースではない)を表します。 この名前がドキュメント化されたクラスにある場合、標準ドックレットはそれへのリンクを作成します。

外部参照クラスへのリンクを作成するには、-linkオプションを使います。 外部参照クラスは、コマンドラインでjavadocツールに渡されないクラスです。 生成ドキュメント内で外部参照クラスにリンクしている箇所は、外部参照または外部リンクと呼ばれます。 たとえば、標準ドックレットをjava.awtパッケージのみで実行する場合、java.lang内のObjectなどのクラスは外部参照クラスです。 外部参照クラスにリンクするには、-linkおよび-linkofflineオプションを使用します。 外部参照クラスのソース・コメントは、javadocコマンドの実行で利用できません。

参照クラスに属していない名前のドキュメントを参照するには、他の2つの@seeタグ形式を使います。

labelは、省略可能なテキストで、リンクのラベルとして表示されます。 labelには空白を含めることができます。 ラベルを省略すると、package.class.memberが表示され、現在のクラスおよびパッケージと比較して適切に短縮されます。

JDK 1.0で導入

@serial

デフォルトの直列化可能フィールドのドキュメンテーション・コメントで使用します。 クラスの直列化可能なフィールドおよびデータの文書化(http://docs.oracle.com/javase/8/docs/platform/serialization/spec/serial-arch.html#5251)を参照してください

Oracleの直列化された形式の仕様にクラスを含める基準(http://www.oracle.com/technetwork/java/javase/documentation/serialized-criteria-137781.html)も参照してください

オプションのフィールドの説明では、フィールドの意味を説明し、許容される値をリストする必要があります。 必要に応じて、複数の行に渡って説明を記述できます。 標準ドックレットは、この情報を、直列化された形式のページに追加します。

クラスを直列化可能にした後で直列化可能フィールドをクラスに追加した場合、主説明に、追加したバージョンを識別する文を追加する必要があります。

includeおよびexclude引数は、直列化された形式ページにクラスまたはパッケージを含めるか除外するかを示します。 これらの引数には、次のような効果があります。

たとえば、javax.swingパッケージは、package-info.javaの@serial excludeタグでマークされます。 パブリック・クラスjava.security.BasicPermissionは、@serial除外タグでマークされます。 package-privateクラスjava.util.PropertyPermissionCollectionは、@serial includeタグで指定されています。

クラス・レベルで指定された@serialタグは、パッケージ・レベルで指定された@serialタグをオーバーライドします。

JDK 1.2で導入

@serialData

data-descriptionの値を使用して、直列化された形式でのデータの型と順序をドキュメント化します。 このデータには、writeObjectメソッドによって書き込まれるオプションのデータと、Externalizable.writeExternalメソッドによって書き込まれるすべてのデータ(ベース・クラスを含む)が含まれます。

@serialDataタグは、readObject、writeObject、readExternal、writeExternal、readResolveおよびwriteReplaceメソッドのドキュメント・コメントで使用できます。

JDK 1.2で導入

@serialField

Serializable classのserialPersistentFieldsメンバーのObjectStreamFieldコンポーネントを文書化します。 各ObjectStreamFieldコンポーネントに対して@serialFieldタグを1つ使用してください。

JDK 1.2で導入

@since

生成されたドキュメントに、指定したsince-text値を持つ"以来"見出しを追加します。 このテキストには、特別な内部構造はありません。 このタグは、概要、モジュール、パッケージ、クラス、インタフェース、コンストラクタ、メソッドまたはフィールドなどのドキュメント・コメントで有効です。 このタグは、特定の変更または機能が、since-textの値で示されたソフトウェア・リリース以降、存在していることを意味します。たとえば、@since 1.5のように使います。

Javaプラットフォームのソース・コードの場合、@sinceタグは、JavaプラットフォームAPI仕様のバージョンを示します。そのソース・コードがリファレンス実装に追加された時期を示すとはかぎりません。 複数の@sinceタグが許可され、複数の@authorタグのように扱われます。 プログラム要素が複数のAPIで使用される場合、複数のタグを使用できます。

JDK 1.1で導入

@throws

@exceptionタグと同じ動作になります。

@throwsタグは、class-nameおよびdescriptionテキストとともに、"Throws"小見出しを生成されたドキュメントに追加します。 クラス名は、メソッドによってスローされる可能性がある例外の名前です。 このタグは、メソッドまたはコンストラクタのドキュメンテーション・コメント内でのみ有効です。 クラス名が完全修飾されていない場合、標準ドックレットでは検索順序を使用してこのクラスが検索されます。 1つのドキュメンテーション・コメントで、同じ例外または異なる例外の@throwsタグを複数使用できます。

チェックされたすべての例外がドキュメント化されるように、throws句の例外に@throwsタグが存在しない場合、標準ドックレットは、@throwsタグでドキュメント化されたかのように、生成された出力にその例外を(説明なしで)追加します。

オーバーライドされるメソッド内で例外が明示的に宣言されている場合のみ、@throwsドキュメンテーションがそのメソッドからサブクラスにコピーされます。 インタフェース・メソッドから実装メソッドにコピーされる場合も同様です。 @throwsタグにドキュメンテーションを継承させるには、{@inheritDoc}タグを使用できます。

JDK 1.2で導入

@uses

このタグは、モジュール宣言のドキュメント・コメントにのみ表示され、モジュールがサービスを使用できることをドキュメント化するのに役立ちます。 説明は、必要なサービスの特性、およびサービスのプロバイダが利用できない場合のモジュールの動作を指定するために使用できます。

JDK 9で導入

@version

-versionオプションを使用すると、指定されたversion-text値を持つ"バージョン"小見出しを生成された文書に追加します。 このタグは、このコードが含まれるソフトウェアの現在のリリース番号を保持するように意図されています。これに対し、@sinceは、このコードが導入されたリリース番号を保持します。 version-textの値には、特別な内部構造はありません。

1つのドキュメンテーション・コメントに複数の@versionタグを含めることができます。 必要に応じて、@versionタグごとに1つのリリース番号を指定することも、タグごとに複数のリリース番号を指定することもできます。 前のケースでは、標準ドックレットはカンマ(,)と名前の間にスペースを挿入します。 後者の場合は、テキスト全体が、解析されることなく、生成ドキュメントにコピーされます。 したがって、カンマ以外のローカライズ・セパレータが必要な場合は、1行に複数の名前を使用できます。

JDK 1.0で導入

インライン・タグ

インライン・タグは中カッコ({ })で囲まれており、通常は説明テキストおよびHTMLが許可されている場所に表示されます。

{@code}

<code>{@literal text }</code>と同等です。

テキストをHTMLマークアップまたはネストされたJavadocタグとして解釈せずに、textをコード・フォントで表示します。 これにより、パラメータ型(<Object>)、不等式(3 < 4)、矢印(->)などのドキュメント・コメントで、HTMLエンティティ(&lt;および&gt;)のかわりに通常の山カッコ(<および>)を使用できます。 たとえば、ドキュメンテーション・コメントのテキスト{@code A<B>C}は、生成されたHTMLページでそのままA<B>Cと表示されます。 つまり、<B>は太字であると解釈されず、コード・フォントになります。 コード・フォントを使用せずに同じ機能が必要な場合は、{@literal}タグを使用します。

JDK 1.5で導入

{@docRoot}

生成されるページから見た、生成ドキュメントの(生成先の)ルート・ディレクトリへの相対パスを表します。 このタグは、著作権のページや会社のロゴなど、生成されるすべてのページから参照するファイルを組み込むときに便利です。 通常は、各ページの下部から著作権のページにリンクします。

この{@docRoot}タグは、コマンド行からも、ドキュメンテーション・コメントの中でも使用できます。 このタグは、すべてのドキュメント・コメント(概要、モジュール、パッケージ、クラス、インタフェース、コンストラクタ、メソッドおよびフィールド)で有効です。これには、任意のタグのテキスト部分(@return、@param、@deprecatedタグなど)が含まれます。

たとえば、コマンドラインで、ヘッダー、フッターまたは下部が定義されているとします。

javadoc -bottom '<a href="{@docRoot}/copyright.html">Copyright</a>'.

{@docRoot}タグをメイク・ファイルでこのように利用する場合、一部のmakefileプログラムでは、中カッコ{}文字をエスケープする必要があります。 たとえば、Inprise MAKEバージョン5.2をWindows上で実行する場合は、{{@docRoot}}のように、中カッコを二重にする必要があります。 さらに、-bottomなどのオプションに対する引数を、単一引用符ではなく、二重引用符で囲む必要があります。href引数の値を囲む引用符は省略します。

たとえば、ドキュメント・コメントでは次のようになります。

/**
 * See the <a href="{@docRoot}/copyright.html">Copyright</a>.
 */

このタグが必要な理由は、生成ドキュメントが、サブパッケージと同じ深さを持つ階層構造のディレクトリに格納されるからです。 式<a href="{@docRoot}/copyright.html">は、java/lang/Object.javaの場合は<a href="../../copyright.html">、java/lang/ref/Reference.javaの場合は<a href="../../../copyright.html">に解決されます。

JDK 1.3で導入

{@index}

単語またはフレーズをオプションの簡単な説明とともに、標準ドックレットによって生成された索引ファイルに含めることを宣言します。 索引エントリは、生成されたドキュメントのこの時点で表示される語句にリンクされます。 この説明は、頭字語など、索引付けされる単語またはフレーズがそれ自体で明確でない場合に使用できます。

JDK 9で導入

{@inheritDoc}

もっとも近い継承可能なクラスまたは実装可能なインタフェースから、このタグの現在のドキュメンテーション・コメントに、ドキュメントを継承(コピー)します。 この機能により、より汎用的なコメントを継承ツリーの上位に記述し、コピーしたテキストを使って記述することができます。

このタグは、ドキュメンテーション・コメントの次の位置でのみ有効です。

継承階層でコメントを見つける方法については、「メソッド・コメントの継承」を参照してください。 このタグが見つからない場合、コメントは、このセクションで説明するルールに応じて、自動的に継承されるかどうかが決まります。

JDK 1.4で導入

表示テキストlabelを持つインライン・リンクを挿入します。このリンクは、参照クラスの指定されたパッケージ、クラス、またはメンバー名のドキュメンテーションを指し示します。 このタグは、概要、モジュール、パッケージ、クラス、インタフェース、コンストラクタ、メソッドおよびフィールド(@return、@param、@deprecatedタグなど、任意のタグのテキスト部分を含む)のすべてのドキュメント・コメントで有効です。

このタグは、@seeタグに似ています。 どちらのタグも、同じ参照を必要とし、package.class#memberおよびlabelに対して同じ構文を受け入れます。 主な違いは、{@link}タグがリンクを"関連項目"セクションに配置するのではなく、インライン・リンクを生成することです。 インライン・テキストの他の部分と区別するために、{@link}タグの最初と最後に中カッコを記述します。 ラベルの中で右中カッコ(})を使う必要がある場合は、HTMLエンティティ表記「&#125;」を使います。

1つの文の中で使用できる{@link}タグの数に制限はありません。

たとえば、次のコメントではgetComponentAt(int, int)メソッドを参照しています。

Use the {@link #getComponentAt(int, int) getComponentAt} method.

標準ドックレットでは、上記のコードから次のHTMLが生成されます(同じパッケージの別のクラスを参照している場合)。

Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method.

上記の行は、Webページ上では次のように表示されます。

getComponentAtメソッドを使用します。

JDK 1.2で導入

{@linkplain}

リンクのラベルがコード・フォントではなくプレーン・テキストで表示される点以外は{@link}と同じ動作になります。 ラベルがプレーン・テキストで記述されていると便利です。 たとえば、Refer to {@linkplain add() the overridden method}.は次のように表示されます: Refer to the overridden method.

JDK 1.4で導入

{@literal}

テキストをHTMLマークアップまたはネストされたJavadocタグとして解釈せずに、textを表示します。 これにより、HTMLエンティティ(&lt;および&gt;)のかわりに山カッコ(<および>)を、パラメータ型(<Object>)、不等式(3 < 4)または矢印(->)などのドキュメント・コメントで使用できます。 たとえば、ドキュメンテーション・コメントのテキスト{@literal A<B>C}は、生成されたHTMLページでそのままA<B>Cとブラウザに表示されます。 <B>は太字であると解釈されません(コード・フォントにならない)。 コード・フォントのテキストで同じ機能が必要な場合は、{@code}タグを使用します。

JDK 1.5で導入

{@summary}

API記述の最初の文を識別して使用するためのデフォルト・ポリシーのかわりに、API記述のサマリーを特定します。 タグは、説明の先頭で使用する場合にのみ意味を持ちます。 いずれの場合も、タグはコンテンツをレンダリングするだけでレンダリングされます。

JDK 10で導入

{@value}

定数の値を表示します。 {@value}タグが静的フィールドのドキュメンテーション・コメントで引数なしで使用されている場合、その定数の値が表示されます。 

/**
 * The value of this constant is {@value}.
 */
public static final String SCRIPT_START = "<script>"

ドキュメント・コメント内の引数package.class#fieldとともに使用すると、{@value}タグは指定された定数の値を表示します。

/**
 * Evaluates the script starting with {@value #SCRIPT_START}.
 */
public String evalScript(String script) {}

引数package.class#fieldは、メンバーが静的フィールドである必要があることを除き、@seeタグ引数と同様の形式をとります。

JDK 1.4で導入

タグを使用できる場所

次の項では、どのタグをどのコンテキストで使用できるかをまとめます。

概要

「概要」ページはどの宣言にも関連付けられていません。 通常は、javadocコマンドのオプションで指定します。

モジュール宣言

パッケージ宣言

型宣言

型宣言には、クラス、インタフェース、列挙型および注釈型の宣言が含まれます。

実行可能メンバー宣言

実行可能メンバー宣言には、コンストラクタ、メソッドおよび注釈型のメンバーの宣言が含まれます。

@returnはコンストラクタでは使用できません。@serialDataは、readObject、writeObject、readExternal、writeExternal、readResolveおよびwriteReplaceメソッドのドキュメント・コメントでのみ使用できます。

フィールド宣言

Copyright © 1994, 2017, Oracle and/or its affiliates. All rights reserved.