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-プラグインバージョンが低いため、アップグレードしてください 3.3+ それだけで完了です。

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

C:\MVN\consumerBanking> mvn site

Mavenがドキュメント生成を開始しました：

[INFO] プロジェクトをスキャンしています...
[INFO]　-------------------------------------------------------------------
[INFO] consumerBanking ビルド中
[INFO] タスク-segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: デフォルト-site}]
[INFO] アーティファクト org.apache.maven.skins:maven-デフォルト-スキン:　
中央から更新を確認しています
[INFO] についてのレポート生成中。
[INFO] イシュー追跡レポート生成中。
[INFO] プロジェクトチームレポート生成中。
[INFO] 依存関係レポート生成中。
[INFO] 持続的インテグレーションレポート生成中。
[INFO] ソースリポジトリレポート生成中。
[INFO] プロジェクトライセンスレポート生成中。
[INFO]　"メーリングリスト"レポート生成。
[INFO]　"プラグイン管理"レポート生成。
[INFO]　"プロジェクト要約"レポート生成。
[INFO]　-------------------------------------------------------------------
[INFO]　BUILD　SUCCESSFUL
[INFO]　-------------------------------------------------------------------
[INFO]　合計時間:　16　秒
[INFO]　完了時:　Wed　Jul　11　18:11:18　IST　2012
[INFO]　最終メモリ:　23M/148M
[INFO]　-------------------------------------------------------------------

を C:\MVN\consumerBanking\target\site フォルダー。以下を index.html これでドキュメントが見られます。

Mavenは、 Doxiaのドキュメント処理エンジンを使用してドキュメントを作成します。それは、さまざまなフォーマットのソースコードを一般的なドキュメントモデルに読み込むことができます。プロジェクトのドキュメントを書くために、Doxiaが変換できる以下の一般的なフォーマットのいずれかを使用できます。