skillup

技術ブログ

Java

mavenでJavadoc出力

投稿日:

Netbeansでプロジェクトから右クリックでjavadocの生成はできますが、実はmavenでビルドするときにJavadocを生成できます。

ただ出力するだけではなくてパラーメータをいろいろとセットできます。

javadoc出力プラグイン

以下をpom.xmlに記述しておけばOKです。

configurationにパラメーターを設定できます。

パラメータ 概要
author javadoc に @author の記述を反映するか否かを設定できます。 (true / false)
charset 生成される javadoc の HTML 内の meta タグに出力される文字エンコードを設定します。
通常はUTF-8にしておきましょう。
docencoding javadoc の HTML ファイルの文字エンコードを設定します。
通常はUTF-8にしておきましょう。
encoding ソースコードの文字エンコーディングを設定します。
通常はUTF-8にしておきましょう。
show javadoc に含めるクラスのアクセスレベルを設定します。 デフォルトでは protected レベルのクラスまで含める事になっています。
“public”, “protected”, “private”, “package” の値を設定できます。通常はprivateのプロパティやメソッドはjavadocに出力されませんが、ここでprivateを設定しておけばJavadocに出力されます。
source ソースコードの Java バージョンを指定します。
2015年4月現在はJava8が最新ですので1.8です。

このように設定しておきますとビルド時にjavadocのHTMLが生成されます。

下記を参考にさせてもらいました。

http://weblabo.oscasierra.net/maven-javadoc-plugin-1/

ちなみにmavenでjavadocを出力する際のゴールはsiteで、

mvn javadoc:javadocでも出力できます。

さまざまなパラメーターがあり、いろいろとカスタマイズできます。

下記のリンクに詳しくのっています。

http://happy-camper.st/lang/java/maven2/plugins/maven-javadoc-plugin.html

-Java
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

型情報の取得・活用について

Javaで抽象度の高い実装を行うときに必要となる型情報の活用法について。 できるとできないとでプログラムの応用範囲が変わってくるのでメモっときます。 こちらのエントリーと合わせて読むといいと思います。 …

no image

開発環境と本番での設定ファイル変更

開発と本番で設定ファイル自体(web.xmlなど)はわけると思うのですが、以前はわからず、開発のものと本番のものを手動でわけていました。 Javaでどうやってやるかを調べたところ、pomにかなり便利な …

no image

CIことはじめ

業務でJavaのテキスト変換ツールを作成。 プログラムよりもCIツールを使って他人の環境下で正常に稼動させるためにどうするかの調査に時間かかりましたね。 今回やりたかったことは下記の通りです。いわゆる …

no image

データベース文字コード対策他

Contents1 JDBC文字化け対策2 BigDecimal2.1 ソース2.2 参考リンク3 CreateQuery4 jsfのconvertNumber JDBC文字化け対策 データベースがu …

no image

Javaでのコーディングで気を付けること

会社でSoftWareDesignを定期購読しており、Javaのコーディングで気をつけることなどがあったので、ちょっとチェック。 以前も似たようなエントリーは書いたことがあったのだけど、再確認。メモ書 …