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

CIことはじめ

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

no image

JSFのプルダウンに関して(イベントをトリガーにする&非ajax)

いろいろと社内アプリを作っていたせいでかなりプルダウンは慣れたとおもったのですが、未知の部分がさらにあったのでまとめます。 Contents1 初期値に値がないとき2 プルダウン変更時に遷移 初期値に …

no image

JPAまとめ

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

no image

正規表現(判定:置換:抽出)

Javaの正規表現を利用した置換、抽出について書きます。 Contents1 正規表現の基本ルール2 Javaでの正規表現の処理の流れ3 実処理3.1 判定3.2 抽出3.3 置換 正規表現の基本ルー …

no image

サーブレットのスコープ

JavaEEではスコープアノテーションによって変数のスコープを使い分けられたのですが、サーブレットの場合はプログラムの中で使い分けます。 通常はページ、リクエストとセッション、アプリケーションぐらいで …