Maven プロジェクトドキュメント

この章では、Maven プロジェクトドキュメントの作成方法について主に学びます。

例えば、C:/MVN ディレクトリの下に consumerBanking プロジェクトを作成した場合、Maven は以下のコマンドを使用して Java プロジェクトをすばやく作成します。

mvn archetype:generate -DgroupId=com.companyname.bank -DartifactId=consumerBanking -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

pom.xml を編集し、以下の設定を追加します(ない場合):

<project> ... <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.7</version> </plugin> </plugins> </pluginManagement> </build> ... </project>

そうしないと、 mvn siteコマンドを実行する際に発生するjava.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent問題は、maven-site-plugin のバージョンが低すぎるためで、3.3+ にアップグレードすれば解決します。

consumerBanking フォルダを開き、以下の mvn コマンドを実行します。

C:\MVN\consumerBanking> mvn site

Maven がドキュメントの生成を開始します:

[INFO] Scanning for projects...
[INFO] -------------------------------------------------------------------
[INFO] Building consumerBanking
[INFO]task-segment: [site]
[INFO] -------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.maven.skins:maven-default-skin: 
checking for updates from central
[INFO] Generating "About" report.
[INFO] Generating "Issue Tracking" report.
[INFO] Generating "Project Team" report.
[INFO] Generating "Dependencies" report.
[INFO] Generating "Continuous Integration" report.
[INFO] Generating "Source Repository" report.
[INFO] Generating "Project License" report.
[INFO] Generating "Mailing Lists" report.
[INFO] Generating "Plugin Management" report.
[INFO] Generating "Project Summary" report.
[INFO] -------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] -------------------------------------------------------------------
[INFO] Total time: 16 seconds
[INFO] Finished at: Wed Jul 11 18:11:18 IST 2012
[INFO] Final Memory: 23M/148M
[INFO] -------------------------------------------------------------------

開いてくださいC:\MVN\consumerBanking\target\siteフォルダ。クリックするとindex.htmlドキュメントを見ることができます。

Maven は、Doxiaというドキュメント処理エンジンを使用してドキュメントを作成します。これは、複数の形式のソースコードを共通のドキュメントモデルに読み取ることができます。

形式名説明参照
Apt プレーンテキストドキュメント形式 http://maven.apache.org/doxia/references/apt-format.html
Xdoc Maven 1.x のドキュメント形式の1つ http://jakarta.apache.org/site/jakarta-site2.html
FML FAQ ドキュメントに適用 http://maven.apache.org/doxia/references/fml-format.html
XHTML 拡張可能な HTML ドキュメント http://en.wikipedia.org/wiki/XHTML
その他の拡張