新・Java入門編41: Javadocについて学習しよう

Java SE 日本語ドキュメント
https://www.oracle.com/jp/java/technologies/documentation.html

Java® Platform, Standard Edition & Java Development Kit バージョン17 API仕様
https://docs.oracle.com/javase/jp/17/docs/api/index.html

標準タグには次のような種類があり、記述できる箇所が決まっています。

タグ	概要	モジュール	パッケージ	型	コンストラクタ	メソッド	フィールド	説明
{@code}	◯	◯	◯	◯	◯	◯	◯	テキストをHTMLマークアップまたはネストされたJavadocタグとして解釈せずに、コードフォントでテキストを表示します
@deprecated		◯		◯	◯	◯	◯	このAPIが使用すべきでないことを示すために、アノテーションと組み合わせて使用​​されます
{@docRoot}	◯	◯	◯	◯	◯	◯	◯	生成されたドキュメントのルートディレクトリへの相対パスを表します
@exception					◯	◯		現在推奨されている形式である@throwsタグと同等です
@hidden				◯		◯	◯	生成されたAPIドキュメントからプログラム要素を非表示にします
{@index}	◯	◯	◯	◯	◯	◯	◯	標準ドックレットによって生成される索引ファイルに含める必要があることを宣言します
{@inheritDoc}				◯		◯		最も近い継承可能なクラスまたは実装可能なインターフェースから、このタグの位置にある現在のドキュメントコメントにドキュメントを継承 (コピー) します
{@link}	◯	◯	◯	◯	◯	◯	◯	表示可能なテキストラベルを持つインラインリンクを挿入します
{@linkplain}	◯	◯	◯	◯	◯	◯	◯	ラベルがコードフォントではなくプレーンテキストで表示されることを除いて、タグと同じように動作します
{@literal}	◯	◯	◯	◯	◯	◯	◯	テキストをHTMLマークアップまたはネストされたJavadocタグとして解釈せずにテキストを表示します
@param				◯	◯	◯		指定されたパラメータ名の後に指定された説明が続くパラメータを「パラメータ」セクションに追加します
@provides		◯						このサービスプロバイダーのインスタンスの取得方法とプロバイダーの重要な特性を指定するために使用します
@return						◯		説明テキストを含む「戻り値」セクションを追加します
@see	◯	◯	◯	◯	◯	◯	◯	参照を指すリンクまたはテキストエントリを含む「関連項目」見出しを追加します
@serial			◯	◯			◯	シリアル化可能フィールドのドキュメントコメントで使用されます
@serialData						1		シリアル化された形式でデータのタイプと順序を示します
@serialField							2	serialPersistentFieldsについて文書化します
@since	◯	◯	◯	◯	◯	◯	◯	指定された値を持つ「導入されたバージョン」見出しを、生成されたドキュメントに追加します
{@summary}	◯	◯	◯	◯	◯	◯	◯	API記述の最初の文を特定して使用するためのデフォルト・ポリシーの代わりに、API記述のサマリーを特定します
{@systemProperty}		◯	◯	◯	◯	◯	◯	システム・プロパティの名前を指定します
@throws					◯	◯		クラス名と説明テキストとともに、生成されたドキュメントに「Throws」という小見出しを追加します
@uses		◯						サービスがモジュールによって使用される可能性があることを示します
{@value}	◯	◯	◯	◯	◯	◯	◯	定数値を表示します
@version	◯	◯	◯	◯				ソフトウェアのバージョンを示します

1. @serialData は次のメソッドのドキュメントコメントでのみ使用できます。
readObject、writeObject、readExternal、writeExternal、readResolve、writeReplace。

2. @serialField は次のフィールドのドキュメントコメントでのみ使用できます。
serialPersistentFields。

serialPersistentFields
https://docs.oracle.com/javase/jp/17/docs/api/java.base/java/io/Serial.html