Tweet

JavaDoc (Javaクラスのドキュメント)の作成方法を紹介します。 Java SDKに付属のコマンド "javadoc" を使うことで、Javaクラス群からドキュメントを作成できます。

 somedir/
     docdir/
     test/
         some/
             package/
                 Test.java

上記のようなディレクトリ構成があるとします。 somedirというディレクトリに、docdirとtestというディレクトリがあります。 docdirは、ドキュメントを出力するためのディレクトリです。 test/some/package/Test.java は、test.some.packageパッケージに属するクラスです。

somedir$ javadoc -d docdir test.some.package

このように、ディレクトリsomedirで、javadocコマンドを実行することで、ドキュメントを作成できます。 -d オプションで、ドキュメントの出力先を指定します。 その後に、ドキュメントを作成したいJavaのパッケージ名を指定します。 今回は test.some.package パッケージを指定しています。

お問い合わせは sweng.tips@gmail.com まで。