概要コメントファイル
出典: フリー百科事典『ウィキペディア(Wikipedia)』 (2020/04/19 04:36 UTC 版)
「Javadoc」の記事における「概要コメントファイル」の解説
ドキュメント全体の概要を示す概要コメントファイル (overview.html) を記述する。これらの文法は以下のような簡単なHTMLとなる。
ここに概要コメントを記述する。 概要コメントファイル (overview.html) はJavadocコマンド実行時に-overviewオプションでディレクトリパスを指定するか、または、パッケージを置いているソースツリーのルートにoverview.htmlファイルを置くことでドキュメントに含められる。※この「概要コメントファイル」の解説は、「Javadoc」の解説の一部です。
「概要コメントファイル」を含む「Javadoc」の記事については、「Javadoc」の概要を参照ください。
- 概要コメントファイルのページへのリンク