タグをオーバーライドします。節「クラスの直列化可能なフィールドおよびデータの文書化」を参照してください。FAQ」も参照してください。javadocの警告が表示される」などの一般的な質問への回答が記載されています。直列化形式仕様にクラスを含める場合には、Sunの仕様も参照してください。コンポーネントをドキュメント化します。data-descriptiondata-descriptionは、直列化された形式でのデータの型と順序を説明するテキストです。メソッドのドキュメンテーションコメントで使用できます。since-textを書き込みます。このテキストには、特別な内部構造はありません。このタグは、すべてのドキュメンテーションコメント、つまり概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドで有効です。このタグは、特定の変更または機能が、since-textに示されたソフトウェアリリース以降、存在していることを意味します。API仕様のバージョンを示します。その変更や機能がリファレンス実装に追加された時期を示すとは限りません。タグのように扱われます。APIで使用される場合、複数のタグを使用できます。@exceptionタグは同義です。descriptionテキストを書き込みます。class-nameは、そのメソッドからスローされる可能性のある例外の名前です。このタグは、メソッドまたはコンストラクタのドキュメンテーションコメントでのみ有効です。ツールは、検索順序に従ってクラスを探します。@throwsタグは、同じまたは異なる例外について、所与のドキュメンテーションコメントで使用できます。(説明なし)に自動的に追加します。オーバーライドされるメソッド内で例外が明示的に宣言されている場合のみ、@throwsドキュメンテーションをそのメソッドからサブクラスにコピーします。同じことは、インタフェースメソッドから実装メソッドへコピーする場合にも当てはまります。ドキュメンテーションを継承させるには、{@inheritDoc}を使用できます。詳細については、@throwsタグのドキュメントを参照してください。フィールドのドキュメンテーションコメントで使用される場合(引数なし)、その定数値が表示されます。package.class#fieldとともに使用すると、指定の定数値が表示されます。フィールドに属していなければなりません。これらの定数値は、定数フィールド値のページにも表示される値です。version-textを書き込みます。このタグは、このコードが含まれるソフトウェアの現在のバージョン番号を保持するように意図されています。このコードが導入されたバージョン番号を保持します。version-textには、特別な内部構造はありません。バージョンタグを使用できる場所を調べるには、「タグを使用できる場所」を参照してください。@versionタグを含めることができます。1つのバージョン番号を指定することも、タグごとに複数のバージョン番号を指定することもできます。(,)とスペースが挿入されます。後者の場合は、テキスト全体が、解析されることなく、生成ドキュメントにそのままコピーされます。つのタグに複数の名前を指定できます。詳細については、@versionタグのドキュメントを参照してください。タグを使用できる場所ここでは、タグを使用できる場所について説明します。タグは、すべてのドキュメンテーションコメントで使用できます。概要のドキュメンテーションタグ概要タグは、概要ページのドキュメンテーションコメントで使用できるタグです。overview.htmlという名前のソースファイル内にあります。ほかのドキュメンテーションコメントの場合と同様に、これらのタグは、主説明のあとで使う必要があります。{@link}タグにバグがあります。テキストは正しく表示されますが、リンクが設定されません。現在のところ、{@docRoot}タグは、概要ドキュメント内では動作しません。{@linkplain}{@docRoot}パッケージドキュメンテーションタグパッケージタグは、パッケージのドキュメンテーションコメントで使用できるタグです。このドキュメンテーションコメントは、package.htmlという名前のソースファイル内にあります。引数を指定したものだけです。{@linkplain}{@docRoot}クラスおよびインタフェースドキュメンテーションタグ以下に、クラスまたはインタフェースのドキュメンテーションコメントで使用できるタグを示します。引数を指定したものだけです。{@linkplain}{@docRoot}次にクラスコメントの例を示します。...}フィールドドキュメンテーションタグ以下に、フィールドのドキュメンテーションコメントで使用できるタグを示します。次にフィールドコメントの例を示します。1263732;コンストラクタおよびメソッドドキュメンテーションタグ次に、コンストラクタまたはメソッドのドキュメンテーションコメント内で使用できるタグを示します。タグは、特定の直列化されたメソッドのドキュメンテーションコメントでのみ使用できます。{@linkplain}{@inheritDoc}{@docRoot}次にメソッドのドキュメンテーションコメントの例を示します。ツールは、ドックレットを使って出力を決定します。ツールは、-docletオプションでカスタムドックレットが指定されている場合以外は、デフォルトの標準ドックレットを使います。Javadocツールには、任意のドックレットとともに使用できるコマンド行オプションがあります。オプション」で説明します。標準ドックレットでは、このほかに、いくつかの追加のコマンド行オプションが提供されます。これらのオプションについては、そのあとの「標準ドックレットが提供するオプション」で説明します。どのオプション名も、大文字と小文字が区別されません。オプションの引数では、大文字と小文字が区別されます。オプションを以下に示します。基本オプションであり、Javadocツールのフロントエンドによって提供され、すべてのドックレットで使用できます。標準ドックレット自体は、イタリックでないオプションを提供します。(overview-summary.html)に配置するように指定します。それぞれ任意の名前と場所を指定できますが、通常は、overview.htmlという名前を付けて、ソースツリー内の最上位のパッケージディレクトリがあるディレクトリに配置します。/src/classes/overview.htmlに配置できます。「使用例」を参照してください。要コメントファイル」を参照してください。複数のパッケージ名を渡した場合だけです。フレーム」を参照してください。概要ページのタイトルは、-doctitleによって設定されます。クラスおよびメンバだけを表示します。クラスとメンバだけを表示します。これはデフォルトの設定です。クラスとメンバだけを表示します。すべてのクラスとメンバを表示します。オンラインヘルプを表示します。ドックレットのコマンド行オプションが一覧表示されます。ドキュメントの生成に使うドックレットを起動するためのクラスファイルを指定します。完全指定の名前を指定してください。このドックレットにより、出力の内容と形式が定義されます。このクラスには、start(Root)メソッドが含まれていなければなりません。この起動クラスへのパスは、-docletpathオプションによって定義されます。ドックレットを呼び出すには、次のように指定します。Doclet」を参照してください。ファイルへのパスを指定します。jarファイルのパスが指定されます。絶対パスまたは現在のディレクトリからの相対パスを指定できます。ファイルを含めることができます。目的のドックレット開始クラスがすでに検索パス内にある場合は、このオプションは不要です。ファイルへのパスの例には、ドックレット開始クラスファイルが含まれています。jarファイル名が含まれている点に注目してください。/home/user/mifdoclet/lib/mifdoclet.jarドックレット開始クラスファイルのパスの例クラスファイル名が省略されている点に注目してください。Doclet」を参照してください。代替機能はありません。1.1によって生成されるのと同じ外見と機能を持つドキュメントを作成するためのものでした。入れ子のクラスはサポートされていません。受け付けるソースコードのバージョンを指定します。次の値を指定できます。導入された総称および他の言語機能を含んだコードを受け付けます。導入された、アサーションを含むコードを受け付けます。1.3以降に導入されたアサーション、総称、または他の言語機能をサポートしません。検索するためのパスを指定します。区切って複数のパスを含めることができます。Javadocツールは、指定されたパス以下のすべてのサブディレクトリを検索します。このオプションを使って、ドキュメント化されるソースファイルの位置だけでなく、それ自体はドキュメント化されないがドキュメント化されるソースファイルから継承されたコメントを持つソースファイルの位置も確認できます。オプションは、javadocコマンドにパッケージ名を渡すときにだけ使用できます。.javaファイルは、このパスからは検索されません。(「1つ以上のクラスのドキュメント化」を参照)。(-classpathを参照)。現在のディレクトリおよびそのサブディレクトリからソースファイルを検索します。sourcepathlistには、ドキュメント化するパッケージ名のソースツリーのルートディレクトリを設定します。com.mypackageという名前のパッケージをドキュメント化する場合に、そのソースファイルが次の場所にあるとします。com.mypackageを指定します。(/home/user/src/com/mypackage)になる」と覚えれば簡単です。つのソースパスを設定するには、次のようにします。検索するパスを指定します。参照クラスとは、ドキュメント化されるクラスとそれらのクラスによって参照されるすべてのクラスのことです。区切って複数のパスを含めることができます。Javadocツールは、指定されたパス以下のすべてのサブディレクトリを検索します。指定するときは、クラスパスのドキュメントにある指示に従ってください。ツールは、-classpathを使って、クラスファイルだけでなくソースファイルも検索します(下位互換性のため)。内のライブラリを使うのであれば、次のように指定します。ツールはこの環境変数を使います。どちらも設定されていない場合、Javadocツールは現在のディレクトリからクラスを検索します。-classpathを使ってユーザクラスを検索する方法についての詳細は、「クラスの検索方法」を参照してください。package1:package2:...ソースファイルから指定されたパッケージおよびそのサブパッケージ内に再帰的にドキュメントを生成します。このオプションは、ソースコードに新しいサブパッケージを追加する際に便利です。新しいサブパッケージは自動的に組み込まれます。ソースファイルを含める必要はありません。引数は、コロンで区切られます(すべてのオペレーティングシステム)。