1 Javadoc

javadocツールは、ソース・ファイルのコレクションを内部形式へと読み込むプログラムです。

構造は次のとおりです: (source-files)->[javadoc-tool:doclet]->(generated files)

Javadocのドックレットは接続可能なバック・エンドのようなもので、いくつかの目標を念頭に置いてこの内部フォームを分析します。このドックレットに基づいて、HTML、MIFまたはXMLファイルを生成できます。

生成されたファイルのコンテンツはドックレットに固有です。標準ドックレットはHTMLドキュメントを生成しますが、他のドックレットの中にはスペルミスのある単語や構文エラーのレポートを生成できるものもあります。

標準ドックレット以外のドックレットを指定した場合、そのドックレットや生成されたファイル(ある場合)の操作にはこのガイドの説明が当てはまらない可能性があります。

javadocツールを使用するには、次の条件を満たしている必要があります。

ソース・コードを書く際にドキュメント・コメントを含めます。ドキュメント・コメントはHTML形式でフォーマットされ、javadocツールが組み入れられています。
javadocツールを実行します。ドキュメント・コメントおよびその他の特別なタグを分析できるように、ドックレットを指定する必要があります。ただし、ドックレットを指定しない場合は、デフォルトで標準ドックレットが含められます。多数のコマンド行オプションを指定しますが、そのうちのあるものはjavadocツールそのものに適用され、あるものは選択されたドックレットに固有です。コマンド行ヘルプにより、現在選択されているドックレットに適用されるツールのオプションを表示および識別できます。標準ドックレットを使用した場合、標準ドックレットによって生成される出力は一連のHTMLページで構成されます。別のドックレットを指定した場合、そのドックレットの操作およびそれにより生成されるファイル(ある場合)は、このガイドで説明されている標準ドックレットと同じ場合もあればそうでない場合もあります。

Javadocの機能

Javadocの機能には、Javadoc検索、HTML5出力の生成のサポート、モジュール・システム内のドキュメント・コメントのサポート、および簡略化されたドックレットAPIが含まれます。

検索

javadocツールは、出力を生成するドックレットを実行します。標準ドックレットでは出力が生成され、その生成されたドキュメントで検索ができます。生成されたAPIには検索ボックスがあり、次のものが提供されています。

APIで定義されている要素や追加のキー・フレーズを検索できます。
結果。まず入力された文字に完全に一致する結果、それに続いて、入力された文字が文字列の任意の場所に含まれる結果が表示されます。複数の結果は検索ボックスの下に単純なスクロール・リストとして表示されます。結果は、分類およびユーザー選択がしやすいように次のように分類されます。
- モジュール
- パッケージ
- タイプ
- メンバー
- 検索タグ
検索語または句が@inheritDocタグを使用して継承されている場合、異なるプログラム要素名がある複数の結果が表示されます。
ユーザー選択に基づくページ・リダイレクション。

次の項目を検索できます。

宣言されているモジュール、パッケージ、タイプおよびメンバーの名前: メソッドはオーバーロード可能であるため、メソッドのパラメータ・タイプの単純名も索引付けされ、検索できます。メソッドのパラメータ名はインデックス化されません。
新しいインライン・タグ@indexを使用してインデックス化された検索語または句: @index内で他のインライン・タグをネストすることはできません。宣言のjavadocコメント内の、@indexでマークされた句または検索語のみを検索できます。たとえば、ドメイン固有の語ulpsがjava.lang.Mathクラス全体で使用されているものの、クラスやメソッドの宣言名には出現しないとします。Math APIのユーザーのために、APIデザイナはクラス・レベルのjavadocコメントやメソッド・レベルのjavadocコメントに各種出現するulpsをタグ付けできます。タグ付けは{@index ulps}を使用して行います。語ulpsはjavadocツールを使用してインデックス化されます。

モジュール・システム

javadocツールはモジュール宣言内のドキュメンテーション・コメントをサポートしています。一部のJavadocコマンド行オプションでは、ドキュメント化するモジュールのセットを指定し、ドキュメント化されるモジュールの新しいサマリー・ページを生成できます。ドキュメント化されるモジュールのセットを構成し、ドキュメント化されるモジュールの新しいサマリー・ページを生成できる、新しいコマンド行オプションがあります。Java Platform, Standard Editionツール・リファレンスのjavadocの章を参照してください。

HTML 5サポート

HTML5出力を生成できます。HTML5完全準拠の出力を得るためには、ドキュメント・コメント内で提供されるHTMLコンテンツがHTML5準拠となっている必要があります。

簡略化されたドックレットAPI

ドックレットAPIでは、すべての言語機能をよりよく表せるように、強力なAPIを使用します。Javadoc標準ドックレットを参照してください。