javadocはJDKに付属するドキュメント生成ツールです。
このツールを使うことで、ソースコード中に記載した/** */形式のドキュメントから、
標準APIのドキュメントと
同じ形式のHTMLファイルを生成してくれます。
Javaのオープンソースのプロダクトなどでもこのjavadocで生成したドキュメントが提供されることが多いですね。
EclipseなどのIDEではメソッド上にカーソルを置くだけでチップヘルプ形式で
javadocコメントを表示してくれたりするので、書いておいて損はありません。
パッケージのドキュメント
javadocにはパッケージに対してのドキュメントも存在します。
(例：java.langパッケージ)
自分のソースでこれを表示させたい場合は、パッケージ配下にpackage.htmlというHTMLファイルを書くのが
古来よりの習わしでした。Java5.0になるまでは。
Java5.0以降ではpackage-info.javaというjavaファイルを利用することが推奨されます。
package-info.javaにはパッケージ宣言とjavadocコメント、そしてアノテーションを記載できます。
/**
*
パッケージのjavadocサンプル。
*
このパッケージにはサンプルコードが置かれます。
*
*
以下のようにパッケージに適用するアノテーションなどを記載することもできます。
*/
@Hoge
package
sample;
投稿日時 : 2008年6月30日 14:22