1 JavaDocツール
JavaDocツールは、ソース・ファイルのコレクションを内部形式へと読み込むプログラムです。
構造は次のとおりです: (source-files)->[javadoc-tool:doclet]->(generated files)
このツールは、プラガブルなバックエンドと同様の方法でJavaDocドックレットを使用して、ソース・ファイルの内部形式を分析し、出力ファイルを生成します。
生成されたファイルのコンテンツはドックレットに固有です。標準ドックレットではHTML出力が生成されますが、スペルミスのある単語や文法的エラーのレポートなど、異なるドックレットでは他の出力が生成される可能性があります。
標準ドックレット以外のドックレットを指定した場合、そのドックレットや生成されたファイル(ある場合)の操作にはこのガイドの説明が当てはまらない可能性があります。
JavaDocツールを使用するには、次のことを行う必要があります:
-
Javaドキュメント・コメントを含むソース・コードを使用します。
-
ドックレットを指定して
javadocツールを実行し、ドキュメント・コメントおよびその他の特別なタグを分析します。コマンドでドックレットを指定しない場合、デフォルトで標準ドックレットが使用されます。
このガイドの説明に加えて、JavaDocツールのユーザーおよびコンテンツ開発者は、次のドキュメントを使用する必要があります:
-
ドキュメント・コメント・タグの指定(コンテンツAPIドキュメントを記述する作成者向け)
-
マニュアル・ページ(APIドキュメントを生成するためにツールを実行するユーザー向け)
- 生成されたドキュメント・バンドルのヘルプ・ページ、および検索指定などの関連指定(APIドキュメントのエンド・ユーザー読者向け)
JavaDocの機能
JavaDocの機能には、JavaDoc検索、HTML出力生成のサポート、モジュール・システムのドキュメント・コメントのサポート、およびJDK 9で導入された新しいドックレットAPIが含まれます。
検索
JavaDocツールにより標準ドックレットが実行されると出力が生成され、これにより、ユーザーが生成されたドキュメントを検索し、生成されたAPIドキュメントに定義されている要素および追加のキー・フレーズを検索できます。検索結果には、検索文字列内の任意の位置の一致する文字が含まれます。検索機能では、ユーザーの選択に基づいてページ・リダイレクションを行うこともできます。
ノート:
検索の使用方法の詳細は、Javadocの検索指定を参照してください。モジュール・システム
javadocツールはモジュール宣言内のドキュメンテーション・コメントをサポートしています。一部のJavaDocコマンド行オプションでは、ドキュメント化するモジュールのセットを指定し、ドキュメント化されるモジュールの新しいサマリー・ページを生成できます。ドキュメント化されるモジュールのセットを構成し、ドキュメント化されるモジュールの新しいサマリー・ページを生成できる、新しいコマンド行オプションがあります。
ノート:
APIドキュメントを生成するためにJavaDocツールを実行するユーザーは、javadocコマンドのマニュアル・ページで詳細を確認してください。HTMLサポート
標準ドックレットは、HTML出力のみを生成します。
ノート:
APIドキュメントのコンテンツを記述する文書作成者は、JavaDoc HTMLファイルを生成するための構文およびタグ付けの要件の詳細について、標準ドックレットのドキュメント・コメントの指定(JDK 17)を参照してください。