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

GlassFish&Junitの不具合

JavaEE(JSF+JavaBean+EJB+JTA)でアプリを製作しているのですが、EJBの部分のjunitができないことが判明しました。 正確に言うとラムダ式を使うと不具合がでます。原因としては …

no image

netbeansのJPQL補助機能

JPAでは基本的に生のSQLではなく、JPQLを使って書きます。 SQLでもタイプミスにイライラさせられることは多いのですが、JPQLはもっとですね・・・爆 そこで使えるのがNetbeansの入力補助 …

no image

日付がらみの処理に関して(MySQL&Java)

MySQL触りだして3年ぐらいたつんですがいまだに整理できないことが多いです。(特に日付がらみ) ちょっとJavaのネタと合わせて整理しておこうかなーと思います。 Contents1 MySQLの日付 …

no image

JPAでのリレーション(アノテーション使用)

JPAでリレーションを管理するとき、最初はアノテーションでやろうとしたんですが、結局やり方がわからずコンストラクタ式をかいて対処してました。 JPAでのリレーションに関して 外部キー制約があるやり方は …

no image

リソースファイルの読み込み

リソースバンドルは基本的にJSFから参照して呼び出すことが多いんですが、もちろんプログラム内からも呼び出すことはできます。 書き方も単純でリソースバンドルをインスタンス生成してメッセージのキーで呼び出 …