Java 9でHTML5準拠のJavadocドキュメントを生成する方法

Java 9より前のバージョンでは、特定のパッケージ、クラス、インターフェース、メソッドに関する情報を調べるには、Googleなどの検索エンジンを使って探す必要がありました。しかしJava 9からは、Javadoc自体に検索機能が組み込まれ、生成されるAPIドキュメントの出力もHTML5標準に準拠するようになりました。

この記事では、実際にサンプルを作成しながら、Java 9でHTML5準拠のJavadocを生成する手順を解説します。

サンプルファイルの作成

まず、「C:/JAVA」フォルダ内に「JavaDocTest.java」というファイルを作成します。コードには、Javadocコメントとしてメソッドの説明やパラメータ情報を記述しておきます。

public class JavaDocTest {
    /**
     * Tutorialspoint を出力するために実行されるデフォルトメソッド
     * @param args コマンドライン引数
     */
    public static void main(String args[]) {
        System.out.println("Tutorialspoint");
    }
}

-html5オプションによるドキュメント生成

Java 9で生成されるドキュメントは、HTML5標準との互換性を持っています。JDK 9のjavadocコマンドに「-html5」オプションを指定することで、生成されるドキュメントがHTML5標準をサポートするようになります。

以下のコマンドを実行して、ドキュメントを生成してみましょう。

C:\JAVA>javadoc -d C:/JAVA -html5 JavaDocTest.java
Loading source file JavaDocTest.java...
Constructing Javadoc information...
Standard Doclet version 9.0.4
Building tree for all the packages and classes...
Generating C:\JAVA\JavaDocTest.html...
Generating C:\JAVA\package-frame.html...
Generating C:\JAVA\package-summary.html...
Generating C:\JAVA\package-tree.html...
Generating C:\JAVA\constant-values.html...
Building index for all the packages and classes...
Generating C:\JAVA\overview-tree.html...
Generating C:\JAVA\index-all.html...
Generating C:\JAVA\deprecated-list.html...
Building index for all classes...
Generating C:\JAVA\allclasses-frame.html...
Generating C:\JAVA\allclasses-noframe.html...
Generating C:\JAVA\index.html...
Generating C:\JAVA\help-doc.html...

このコマンドを実行すると、「C:/JAVA」フォルダの下に以下のようなドキュメントページが生成されます。

• JavaDocTest.html: クラスごとのAPIドキュメント
• package-summary.html: パッケージの概要ページ
• overview-tree.html: 全パッケージとクラスの階層ツリー
• index-all.html: 検索用のインデックスページ

生成された「index.html」をブラウザで開くと、画面右上に検索ボックスが表示されていることが確認できます。ここにクラス名やメソッド名を入力すれば、Googleで検索することなく、APIドキュメント内だけで目的の情報を素早く見つけられます。

まとめ

Java 9のJavadocツールは、-html5オプションを付けるだけでHTML5準拠のモダンなドキュメントを生成でき、さらに組み込み検索機能により、APIリファレンスの利便性が大幅に向上しました。従来のように外部検索エンジンに頼ることなく、開発者はローカルのドキュメントだけで効率的に情報を参照できます。