Maven で javadoc を生成する (maven-javadoc-plugin)

本稿では maven-javadoc-plugin を利用して、Apache Maven で javadoc を生成する方法について解説します。

maven-javadoc-plugin

Maven で javadoc を作成するには maven-javadoc-plugin を利用します。 コマンドとしては次の通りです。

$ mvn javadoc:javadoc

maven-javadoc-plugin の設定を変更する場合は、Plugin の設定を pom.xml に次のように追記します。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <configuration>
    <author>true</author>
    <source>1.7</source>
    <show>protected</show>
    <encoding>UTF-8</encoding>
    <charset>UTF-8</charset>
    <docencoding>UTF-8</docencoding>
  </configuration>
</plugin>

maven-javadoc-plugin の主な設定パラメータは次の通りです。

パラメータ概要
authorjavadoc に @author の記述を反映するか否かを設定できます。 (true / false)
charset生成される javadoc の HTML 内の meta タグに出力される文字エンコードを設定します。
docencodingjavadoc の HTML ファイルの文字エンコードを設定します。
encodingソースコードの文字エンコーディングを設定します。
showjavadoc に含めるクラスのアクセスレベルを設定します。 デフォルトでは protected レベルのクラスまで含める事になっています。
“public”, “protected”, “private”, “package” の値を設定できます。
sourceソースコードの Java バージョンを指定します。

その他のオプションや詳細な情報については、公式ページ を参考にしてください。

Java環境構築へ戻る

著者 : OSCA

OSCA

 初級WEBエンジニアです。最近は Android, iOS, WEBアプリの作成に力を入れています。 個人として何か一つでも世の中の多くの人に使ってもらえるアプリを作ろうと日々奮闘中です。