Javadocの書き方メモ

overview.html

Javadocを最初に開いたときに表示される概要ページのドキュメントを作成する場合、overview.htmlを記述する必要がある。通常は最上位パッケージに配置するが、maven2と連携する場合は/project/src/main/javadoc/にoverview.htmlを配置するとよい。

通常のHTMLと同じように記述する。

package-info.java

パッケージの概要ページ及び、overview-summary.htmlに表示されるパッケージリスト内の説明を作成する場合、パッケージ内にpackage.htmlもしくはpackage-info.javaを配置する必要がある。package-info.javaはJava5以降から対応である。

以下のように記述する。

<code>
/*
 * 通常のファイルヘッダ
 */
/**
 * XXXXをXXXXする機能を提供します。<br>
 * XXXXはXXXXである必要が有ります。<br>
 * ...
 */
@xxx.xxx.AnyAnnotation("必要ならば")
package foo.bar;
</code>