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のオブジェクト指向に関して

Contents1 staticメソッド2 アクセス修飾子3 抽象クラス3.1 オーバーライド(親クラスのメソッドを上書きすること)3.2 オーバーロード(同名メソッドを複数もつこと)4 interf …

no image

mavenのリモートリポジトリについて

JPAでO/Rマッパーに慣れてからというもの通常のSQLをごりごり書くのが億劫になってきました。 億劫というかいろいろとリスクがありますね。 問題点としてはコンパイルするときにエラーが検知できなかった …

no image

JPAでのリレーションに関して

JPAではテーブルをクラスで定義します。もちろん例外とかはいろいろあるのですが、1テーブル1クラスというつくりで、これをエンティティと呼びます。 もともとクラスを作ってからDBを作成したり、JTAの規 …

no image

クラスパスの通し方

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

no image

JSF+ajax

JSFでajaxを使うときにいろいろと調べたのでメモ。 やろうとしたことはWEB上で給与明細の計算をしたくて、プルダウンで月の変更したら自動的に経費が該当月に替わるというシステムです。 ajaxを使う …