機械翻訳について

JavaDoc標準ドックレットによって生成された出力 (JDK 22)

このドキュメントでは、JDK 22のjavadocツールの標準ドックレットによって生成された出力の標準プロパティについて説明します。

互換性

「構造」セクションに示される詳細は、外部コンシューマに関係する側面に関連しています。 次のものが含まれます。

将来、既存の詳細の範囲内に収まらない新しい言語機能に対応し、「直列化された形式」ページや「定数値」ページなど、出力の他の部分を説明するために、追加の詳細を追加できます。

ナビゲーション表およびサマリー表を提供するページの部分は定義されず、変更される可能性があります。 API要素のプライマリ仕様であるページ部分内の内部構造も定義されておらず、変更される可能性があります。

APIドキュメントの詳細な外観をカスタマイズしたいユーザーのために、「CSSクラス」セクションに記載されている詳細が提供されています。 現在はリリース間で変更される可能性がありますが、各ページの高レベル要素のクラスの変更を最小限に抑えるために努力しますが、ページで使用されるフォントや色など、ページの主要な特性を設定するために使用できます。 APIドキュメントの一般的な外観をカスタマイズするだけのユーザーは、標準ドックレットで提供される標準スタイル・シートの:rootセクションで定義されたCSSカスタム・プロパティを変更またはオーバーライドすることをお薦めします。

構造

標準ドックレットによって生成される出力は、文書化される要素の種類に従って、ディレクトリおよびファイルに編成されます。 HTMLファイル内では、要素の種類を示すためにclass属性が使用され、特定の要素を示すためにid属性が使用されます。

たとえば、java.baseモジュールには、isEmpty()メソッドを含むクラスjava.lang.Stringが含まれています。 APIドキュメントでは、このメソッドの詳細なドキュメントはファイルjava.base/java/lang/String.html (生成されたドキュメントのルート・ディレクトリに対する相対)にあり、そのファイル内でメソッドのドキュメントは、開始タグが<section class="detail" id="isEmpty()>"のセクションにあります。

モジュール

モジュール宣言のファイルとその内容はすべて、モジュールにちなんで名付けられた最上位ディレクトリに配置されます。 モジュール宣言自体の詳細は、そのディレクトリ内のファイルmodule-summary.htmlに配置されます。

たとえば、my.moduleという名前のモジュールの詳細は、my.module/module-summary.htmlの宣言自体の詳細とともに、ディレクトリmy.moduleにあります。

モジュールのmodule-info.javaファイルのドキュメント・コメントから導出されたドキュメントは、IDがmodule-descriptionsection要素にあります。

パッケージ

パッケージの宣言のファイルとその内容は、すべてパッケージにちなんで名付けられたディレクトリに配置され、パッケージ名の識別子ごとにディレクトリのレベルが設定されます。 パッケージが名前のないモジュールにある場合、パッケージのディレクトリ階層はドキュメントの最上位ディレクトリに配置されます。パッケージが名前付きモジュールにある場合、ディレクトリ階層はモジュールのディレクトリにルート付けされます。

パッケージ宣言自体の詳細は、パッケージのディレクトリにあるファイルpackage-summary.htmlに配置されます。

たとえば、モジュールmy.moduleからエクスポートされるパッケージmy.pkgの詳細は、ディレクトリmy.module/my/pkgにあり、宣言自体の詳細はmy.module/my/pkg/package-summary.htmlにあります。

パッケージのpackage-info.javaファイルのドキュメント・コメント(もしあれば)から導出されたドキュメントは、IDがpackage-descriptionsection要素にあります。

クラスとインタフェース

最上位クラスまたはインタフェースの宣言のファイルは、クラスまたはインタフェースの単純名にちなんで名付けられたHTMLファイルです。 ファイルは、包含パッケージのディレクトリにあります。

たとえば、モジュールmy.moduleからエクスポートされるクラスmy.pkg.Cの詳細は、ファイルmy.module/my/pkg/C.htmlにあります。

ネストされたクラスまたはインタフェースの宣言のファイルは、ネストされたクラスまたはインタフェースの単純名とその包含するクラスまたはインタフェースの単純名に従って命名されたHTMLファイルです。 ファイルは、包含パッケージのディレクトリにあります。

たとえば、モジュールmy.moduleからエクスポートされるクラスmy.pkg.C.Nestedの詳細は、ファイルmy.module/my/pkg/C.Nested.htmlにあります。

クラスまたはインタフェースのソース・ファイルのドキュメント・コメント(もしあれば)から導出されたドキュメントは、IDがclass-descriptionsection要素にあります。

メンバー

クラスまたはインタフェースのメンバーの詳細は、すぐに囲むクラスまたはインタフェース用のファイルに記載されています。

アクセス修飾子の有無にかかわらず、メンバーのアクセス・レベルは、そのメンバーのプレゼンテーションの構造に影響を与えません。

デフォルトのコンストラクタ、enumクラスおよびrecordクラスの特定のメンバーなどの必須メンバーは、空のドキュメンテーション・コメントまたは適切な生成されたドキュメンテーション・コメントを使用して、通常の方法で宣言されたかのように文書化されます。

Fields

クラスまたはインタフェースのフィールドに関するドキュメント・コメント(もしあれば)から導出されたドキュメントは、クラスfield-detailsを持つsection要素にグループ化されており、クラスdetailを持つsection要素内の各フィールドのドキュメントと、フィールドの名前を示すIDが示されています。

enum定数

enumクラスの列挙定数のドキュメント・コメント(もしあれば)から導出されたドキュメントは、クラスconstant-detailsを持つsection要素にグループ化され、クラスdetailを持つsection要素内の各定数のドキュメントと、定数の名前を示すIDが含まれます。

コンストラクタ

クラスのコンストラクタのドキュメント・コメント(もしあれば)から導出されたドキュメントは、クラスconstructor-detailsを持つsection要素にグループ化され、section要素内の各メソッドのドキュメントは、クラスdetailおよびコンストラクタのシグネチャを指定するID。文字列<init>のあとに、パラメータの完全修飾型のカンマ区切りリストがカッコで囲まれます。 ノート: HTMLファイルでは、<および>文字は、&lt;および&gt;としてエスケープされます。

メソッド

クラスまたはインタフェースのメソッドのドキュメント・コメント(もしあれば)から導出されたドキュメントは、クラスmethod-detailsを持つsection要素にグループ化され、section要素内の各メソッドのドキュメントが示されます。クラスdetailおよびメソッドのシグネチャを提供するID。メソッドの名前と、そのパラメータの完全修飾型のカンマ区切りリスト(カッコで囲まれたもの)で構成されます。

注釈インタフェース要素

注釈インタフェースの要素に関するドキュメント・コメント(もしあれば)から導出されたドキュメントは、クラスmember-detailsを持つsection要素にグループ化されており、クラスdetailを持つsection要素内の各要素のドキュメントと、要素の名前を示すID、その後に()が続きます。

レコード・クラスおよびコンポーネント

レコード・コンポーネントの@paramタグから導出されたドキュメントは、レコード・クラスの主な説明の項のクラスnotesを持つsection要素に含まれています。 明示的または強制的なフィールドおよびメソッドは、標準の方法でドキュメント化されます。

CSSクラス

標準ドックレットでは、次のCSSクラスを使用して、スタイル・シートで提供されるスタイル情報をHTMLページの様々な部分に関連付けます。

追加の詳細

次の定数は、非推奨か"プレビュー"機能かなど、宣言に指定できる追加情報に使用されます。

クラス 説明
deprecated-label 宣言の"deprecated"ステータスを記述するブロック内の"Deprecated"ラベルのクラス。
deprecation-block 宣言の"deprecated"ステータスを記述するブロックのクラス。
deprecation-comment 宣言の"deprecated"ステータスを記述するブロック内の詳細のクラス。
description-from-type-label 説明のコピー元の要素を示すラベルのクラス。
permits-note シール済クラスの許可されたサブタイプに関する情報を提供するノートのクラス。
preview-block 宣言の"プレビュー"ステータスを記述するブロックのクラス。
preview-comment 宣言の"プレビュー"ステータスを記述するブロック内の詳細のクラス。
preview-label 宣言の"プレビュー"ステータスを記述するブロック内の"プレビュー"ラベルのクラス。
tag-list 要素のタグを含むリストのクラス。
tag-list-long 一部のタグに長いラベルがあるか、カンマが含まれている場合の、要素のタグを含むリストのクラス。

詳細

次の定数は、モジュール、パッケージ、型宣言など、囲んでいる要素の(プログラム)要素の詳細に使用されます。

クラス 説明
details 囲まれたプログラム要素に関するすべての詳細のsection要素全体のクラス。
details-list 様々な種類のプログラム要素の詳細を含むサブリストのリストのクラス。
detail 1つの囲まれた要素の詳細を含むsection要素のクラス。
member-list 指定された要素種類のメンバーの詳細を含むリストのクラス。
constructor-details 型要素で宣言されたすべてのコンストラクタの詳細のリストを含むsectionのクラス。
constant-details enum要素で宣言されたすべてのenum定数の詳細のリストを含む、sectionのクラス。
field-details 型要素で宣言されたすべてのフィールドの詳細のリストを含むsectionのクラス。
member-details 注釈型要素で宣言されているすべてのメンバーの詳細のリストを含むsectionのクラス。
method-details 型要素で宣言されたすべてのメソッドの詳細のリストを含むsectionのクラス。
property-details JavaFX型要素で宣言されているすべてのプロパティの詳細のリストを含むsectionのクラス。
serialized-class-details "直列化された形式"ページの要素の直列化された形式の詳細を含むsection要素のクラス。

ドキュメンテーション・コメント

次の定数は、ドキュメント・コメントから生成されたコンテンツを表示するために使用されるコンポーネントに使用されます。

クラス 説明
class-description タイプ要素のドキュメンテーション・コメントを表示するために使用される要素のクラス。 ブロック・タグのコンテンツは、クラス「ノート」のネストされた要素に格納されます。
module-description ブロック・タグを除く、モジュール要素のドキュメント・コメントを表示するために使用される要素のクラス。
package-description パッケージ・エレメントのドキュメンテーション・コメントを表示するために使用されるエレメントのクラスです。 ブロック・タグのコンテンツは、クラス「ノート」のネストされた要素に格納されます。
notes パッケージ、タイプまたはメンバー要素のドキュメント・コメントにブロック・タグを表示するために使用されるdl要素のクラス。 実装や継承の詳細など、追加の(derived)情報もこの要素に表示されます。

フレックス・レイアウト

次の定数は、"flex"レイアウトの最上位構造体のコンポーネントに使用されます。

クラス 説明
flex-box ブラウザ・ウィンドウでの"flex"レイアウトの配置に使用される最上位のdiv要素のクラス。 要素には2つの子要素が含まれている必要があります: 1つはクラスflex-header、もう1つはクラスflex-contentです。
flex-header flex-boxコンテナ内のheader要素のクラス。 要素は、常にビューポートの上部に表示されます。
flex-content flex-boxコンテナ内のdiv要素のクラスこの要素はヘッダーの下に表示され、使用可能な高さに対して大きすぎる場合はスクロールできます。

ヘッダー(タイトル・ブロック)

次の定数は、ページのタイトルを提供するメインの"header" ("見出し")に使用されます。 これは、トップ・ナビゲーション・バーを含むheader要素と混同しないでください。

クラス 説明
header ページのすべてのメイン見出しを含む要素のクラス。
module-label-in-package パッケージ宣言の見出しにある"module"ラベルのクラス。
module-label-in-type 型宣言の見出しにある"module"ラベルのクラス。
package-label-in-type 型宣言の見出しにある"package"ラベルのクラス。
sub-title パッケージまたはタイプの宣言のメイン・タイトルの前にある、モジュールまたはパッケージのラベルおよび名前を含む要素のクラス。
title パッケージまたはタイプの宣言のページのメイン・タイトルのラベルおよび名前を含む要素のクラス。

「ヘルプ」ページ

次の定数は、"ヘルプ"ページの内容に使用されます。

クラス 説明
help-footnote ページ下部の脚注のクラス。
help-note "ノート:"プレフィクスのクラス。
help-section ページ内の各サブセクションのクラス。
help-section-list ページのサブセクションにあるリストのクラス。
help-toc" ページの目次の最上位レベルのリストのクラス。
help-subtoc" ページの目次にある第2レベルのリストのクラス。

次の定数は、様々なページの様々な場所で使用されます。

クラス 説明
block ドキュメント・コメントの一部を含むdiv要素のクラス。
block-list ドキュメント・コメントの一部を含むul要素のクラス。
circle 階層ツリー・ビューのul要素のクラス。
class-uses usesページのクラスをリストするul要素のクラス。
copy 一部のページ・コンテンツをクリップボードにコピーするbutton要素のクラス。
external-link 外部ターゲットを含むリンクのa要素のクラス。
hierarchy 階層ツリー・ビューを含むsection要素のクラス。
horizontal 水平な(インライン)表示スタイルを持つul要素のクラス。
implementation-label モジュール・ページの"provides"エントリの実装の詳細を含むspan要素のクラス。
index 索引ページの本文にあるdl要素のクラス。
inheritance クラス・ページの継承ツリーを含むdiv要素のクラス。
inherited-list クラス・ページで継承されたメンバーのサマリーを含むdiv要素のクラス。
invalid-tag 無効なタグまたはその他の無効なアイテムの通知として機能する要素のクラス。
legal-copy ページ・フッター内の有効なコピーを含むp要素のクラス。
member-name-link メンバー・サマリー・リスト内のリンクのa要素のクラス。
name-value 直列化された形式ページのシリアルUID情報を含むdl要素のクラス。
packages 定数フィールド値ページのpackagesセクションを含むsection要素のクラス。
package-hierarchy-label ツリー・ページのパッケージ階層ラベルを含むspan要素のクラス。
package-uses パッケージのコンテンツ・セクションを含むli要素のクラスは、ページを使用します。
ref-list 外部仕様への参照のリストのクラス。
serialized-package-container 直列化された形式ページのパッケージのsection要素のクラス。
source-container ソース・ページにソース・コードを含むdiv要素のクラス。
source-line-no ソース・ページに行番号を含むspan要素のクラス。
type-name-link クラスまたはインタフェースへのリンクのa要素のクラス。

次の定数は、各ページのheader要素およびfooter要素に表示されるメインのナビゲーション・バーに使用されます。

クラス 説明
top-nav ページのheader要素を含む、div要素全体のクラス。
about-language -headerまたは-footerコマンドライン・オプションによって提供される情報(製品名やバージョンなど)を含む要素のクラス。
nav-bar-cell1-rev 現在のページを示す、ナビゲーション・リンクのリストで強調表示されている項目のクラス。
nav-bar-toggle-icon 小さい表示用のナビゲーション・バー・トグル・ボタンのクラス。
nav-list ナビゲーション・リンクのプライマリ・リストのクラス。
nav-list-search "サーチ"コントロールを含むdiv要素のクラス。
skip-nav ナビゲーション・ヘッダーをスキップするリンクを含むdiv要素のクラス。 通常、この要素は非表示ですが、スクリーン・リーダーを使用してページをナビゲートするときに使用できます。
sub-nav 子会社のナビゲーション・リンクのリストを含むdiv要素のクラス。
sub-nav-list 子会社のナビゲーション・リンクのリストのクラス。
sub-nav-list-small 小さい表示の子会社ナビゲーション・リンクのリストのクラス。

<body>要素のページ・スタイル

次の定数は、対応するページの<body>要素のクラスに使用されます。

クラス 説明
all-classes-index-page "すべてのクラス"索引ページのbody要素のクラス。
all-packages-index-page "すべてのパッケージ"索引ページのbody要素のクラス。
class-declaration-page クラス宣言ページのbody要素のクラス。
class-use-page クラス使用ページのbody要素のクラス。
constants-summary-page 定数-サマリー・ページのbody要素のクラス。
deprecated-list-page 非推奨項目をリストするページのbody要素のクラス。
deprecated-in-release-page 非推奨項目をリストするページのbody要素のクラス。
doc-file-page "doc-file"ページのbody要素のクラス。
external-specs-page "外部仕様"ページのbody要素のクラス。
help-page "help"ページのbody要素のクラス。
index-page "単一"または"分割インデックス"のいずれかのページのbody要素のクラス。
index-redirect-page トップレベルのリダイレクト・ページのbody要素のクラス。
module-declaration-page モジュール宣言ページのbody要素のクラス。
module-index-page module-indexページのbody要素のクラス。
new-api-list-page 新しいAPI要素をリストするページのbody要素のクラス。
package-declaration-page パッケージ宣言ページのbody要素のクラス。
package-index-page package-indexページのbody要素のクラス。
package-tree-page パッケージ階層のページのbody要素のクラス。
package-use-page パッケージ使用ページのbody要素のクラス。
preview-list-page プレビュー・アイテムをリストするページのbody要素のクラス。
search-page 検索ページのbody要素のクラス。
serialized-form-page 直列化された形式ページのbody要素のクラス。
source-page クラスのソース・コードを含むページのbody要素のクラス。
system-properties-page システム・プロパティ・ページのbody要素のクラス。
tree-page クラス階層のページのbody要素のクラス。

検索インデックスと結果

次の定数は、静的検索索引および対話型検索索引の項目に使用されます。

クラス 説明
page-search-details 追加情報を表示する検索ページのdetails要素のクラス。
page-search-info 追加情報を含む検索ページのdiv要素のクラス。
search-tag-link 静的"Index"ページ内の、カスタム検索可能アイテムへのリンクのクラス(@indexタグで定義されるなど)。
search-tag-result カスタム検索可能アイテムのクラス(@indexタグで定義されるなど)。
vertical-separator 静的"Index" page(s)の上部にあるページのリスト内のセパレータのクラス。

署名

次の定数は、要素のシグネチャのコンポーネントに使用されます。

クラス 説明
module-signature モジュール・シグネチャを含む要素のクラス。
package-signature パッケージ・シグネチャを含む要素のクラス。
type-name-label 型シグネチャ内の型名を含むspan要素のクラス。
type-signature 型シグネチャを含む要素のクラス。
member-signature メンバー・シグネチャを含む要素のクラス。 シグネチャにはメンバー名が含まれ、要素の種類に応じて、次のいずれかが含まれます: 注釈、型パラメータ、修飾子、戻り型、パラメータおよび例外。
annotations 要素のシグネチャ内の注釈を含むspan要素のクラス。
exceptions 実行可能要素のシグネチャ内の例外を含むspan要素のクラス。
extends-implements 型要素のシグネチャのextendsまたはimplementsセクションを含むspan要素のクラス。
element-name 要素のシグネチャ内の要素名を含むspanのクラス。
modifiers 要素のシグネチャ内の修飾子を含むspanのクラス。
parameters 実行可能要素のシグネチャ内のパラメータを含むspanのクラス。
permits シール済クラス要素のpermitsセクションを含むspanのクラス。
return-type メソッド要素のシグネチャの戻り型を含むspanのクラス。
type-parameters 型パラメータを合理的にインラインで表示する必要がある場合に使用される、要素のシグネチャ内の型パラメータを含むspanのクラス。
type-parameters-long 型パラメータが長すぎてインラインで表示できない場合に使用される、要素のシグネチャ内の型パラメータを含むspanのクラス。 実装に関するノート: type-parameterstype-parameters-longの選択のしきい値は50文字です。

スニペット

次の定数は、スニペットの内容に使用されます。 また、スニペットの変換では、クラスlanguage-LANGを使用できます。このクラスでは、LANGはスニペット・タグの"lang"属性によって明示的に指定されるか、外部スニペットの種類から推測できます。

クラス 説明
snippet スニペットを表示するpre要素のクラス。
snippet-container スニペット要素を含むdiv要素のクラス。
snippet-copy スニペット・コンテンツをクリップボードにコピーするUI要素のクラス。
bold bold型で強調表示されたテキストのクラス。
italic italic型で強調表示されたテキストのクラス。
highlighted highlighted型で強調表示されたテキストのクラス。

サマリー

次の定数は、要約情報を提供するHTML要素(一部のプログラム要素で囲まれたプログラム要素、または類似のプログラム要素に関する集計情報を提供するページ)に使用されます。 通常、サマリーは表として表示され、行には要素の名前またはシグネチャ、およびその要素の説明の最初の文が含まれます。 通常、名前またはシグネチャは、対応する"詳細"セクションにリンクされます。

ノート: "Services"のモジュール宣言ページの"サマリー"情報は、最初の文だけでなく、@providesタグと@usesタグの説明の全文が含まれているため、"詳細"情報としてより適切に特徴付けられます。

クラス 説明
summary このページで宣言されたプログラム要素の部分のすべての種類のサマリーを含む、section要素全体のクラス。
summary-list このページで宣言されたプログラム要素の部分のすべての種類のサマリーのlist要素のクラス。
constructor-summary 型のコンストラクタのサマリーを含むsection要素のクラス。
field-summary 型のフィールドのサマリーを含むsection要素のクラス。
member-summary 型の特定のタイプのメンバーを含むsection要素のクラス。
method-summary 型のメソッドのサマリーを含むsection要素のクラス。
modules-summary モジュールのモジュール依存関係のサマリーを含むsection要素のクラス。
nested-class-summary 型のネストされたクラスのサマリーを含むsection要素のクラス。
packages-summary モジュールによって提供されるパッケージのサマリーと、"すべてのパッケージ"索引ページのパッケージのリストのクラスを含むsection要素のクラス。
property-summary タイプのプロパティのサマリーを含むsection要素のクラス。
services-summary モジュールによって提供または使用されるサービスのサマリーを含むsection要素のクラス。
constants-summary "定数フィールド値"ページのsection要素のクラス、および列挙クラスの列挙定数のsection要素のクラス。
contents-list ページのコンテンツへのリンクを含む様々なサマリー・ページのul要素のクラス。
preview-feature-list 現在のリリースのプレビュー機能に関する情報を含む、プレビュー・サマリー・ページのul要素のクラス。

"summary"表および"詳細"表には、次の定数が使用されます。 ほとんどの表はサマリー表です。つまり、他の場所の詳細へのリンクが一部提供されます。 モジュール・ページには、ディレクティブの詳細を含む詳細表があります。

クラス 説明
two-column-summary コンテンツを2つの列を含む表としてレンダリングする必要があるdiv要素のクラス。
three-column-summary コンテンツを3つの列を含む表としてレンダリングする必要があるdiv要素のクラス。
three-column-release-summary コンテンツを3つの列を含む表としてレンダリングする必要があるdiv要素のクラス。中間列にはリリース名のみが含まれるため、必要な領域が少なくなります。
four-column-summary コンテンツを4つの列を含む表としてレンダリングする必要があるdiv要素のクラス。
details-table プログラム要素の詳細を表示するために使用されるdiv要素のクラス。
summary-table プログラム要素の囲まれた要素のサマリーを示すために使用されるdiv要素のクラス。 summary-tableは通常、対応するdetails-list内の項目を参照します。
active-table-tab 表の現在表示されている内容を示す"タブ"のクラス。 これは、表がフィルタされたビューを提供する場合に使用されます。
caption 表のキャプションのクラス。 キャプションは、表の上に1つの非アクティブなタブとして表示されます。
checkboxes サマリー表に表示するアイテムを選択するためのチェックボックスの行を含むdiv要素のクラス。
table-header 表ヘッダーの一部である要素のクラス。
table-tab 表の内容の代替ビューを示す"タブ"のクラス。 これは、表がフィルタされたビューを提供する場合に使用されます。
table-tabs 表示する関連表のコンテンツの選択に使用するタブを含むdiv要素のクラス。
col-constructor-name コンストラクタの名前を表示するために使用される表の列のセルのクラス。
col-first 表内のセルの最初の列のクラス。 これは通常、"タイプと修飾子"列で、型はフィールドのタイプまたはメソッドの戻り型です。
col-last 表内のセルの最後の列のクラス。 これは通常、"description"列で、説明は要素ドキュメント・コメントの最初の文です。
col-summary-item-name サマリー・アイテムの名前を表示するために使用される、表の列のセルのクラス。
col-plain 特定のスタイルなしで追加情報を表示するために使用される、表の列のセルのクラス。
col-second 表内のセルの2番目の列のクラス。 これは通常、フィールドの名前、またはメソッドの名前とパラメータを定義する列です。
even-row-color "striped"効果を提供するために、表の行のバックグラウンドを提供するために使用されるクラス。 このクラスおよびodd-row-colorは、代替行で使用されます。 クラスは、表"タブ"を使用して、表示する行のセットをフィルタする場合に動的に適用されます。
odd-row-color "striped"効果を提供するために、表の行のバックグラウンドを提供するために使用されるクラス。 このクラスおよびeven-row-colorは、代替行で使用されます。 クラスは、表"タブ"を使用して、表示する行のセットをフィルタする場合に動的に適用されます。