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

列挙型Enumについて

列挙型のクラスであるEnumについてのメモです。 ちなみにEnumの読み方はイナムまたはイニュームだそうです。 Contents1 列挙型とは?1.1 基本の使い方1.2 key=value的な使い方 …

no image

JavaでのSQLの書き方

ちょっと小ネタです。 通常SQLを記述する場合、縦に分けて書くのが見た目にも見やすく、保守性も高いです。 例として

と書くよりは、 [ …

no image

クラスパスの通し方

今回はNetbeansでなく、IDEを使わずにJavaを使う場合の記事です。 Javaで開発している人の99%はIDEで開発をしていると思うのですが、サーバー上で一時的テストをしないといけないような場 …

no image

CIことはじめ

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

no image

JPAまとめ

JPAわけわかんねーと思い、触りはじめてから3か月ぐらいたちます。 いまだに細かい部分はよくわかっていないことは多いのですが、全体像というか何となくどういうものかはわかり始めてきたいのでまとめたいと思 …