Javadocで生成されるドキュメント

広告

具体的名Javadocの使い方を見ていく前に、実際にJavadocで生成されたドキュメントの例を見ておきましょう。

JDKのAPI解説のページを見てください。(ローカルでもオンラインでも構いません)。

http://java.sun.com/javase/ja/6/docs/ja/api/index.html

例としてBooleanクラスについて見てみます。

Javadocで生成されるドキュメント

Javadocで生成されるドキュメント

このAPI解説のページで表示されているこのHTMLページがJavadocで生成されたドキュメントです。これらのドキュメントはJavaのソースコードに記述されたコメントからJavadocを使って生成されています。

同じように自分のソースコードであっても、Javadocに準拠した書式でコメントを記述するようにしておけば、後から作成したクラスなどに関するドキュメントを作成することができるようになります。またJavadocに準拠した書式といっても普通にコメントとして読んでも何の違和感も無い簡単でシンプルな書式となっています。

次のページで簡単なコメントの記述方法を見ておきます。

( Written by Tatsuo Ikura )

関連記事 (一部広告含む)