Maven-project-documents

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

このチュートリアルでは、アプリケーションのドキュメントを一度に作成する方法を説明します。 それでは始めましょう。前の章で示した例を使用して、java consumerBanking アプリケーションを作成したC：/MVNディレクトリに移動します。 consumerBanking フォルダーを開き、次の mvn コマンドを実行します。

C:\MVN>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]-----------------------------------------------

これでプロジェクトのドキュメントの準備ができました。 Mavenはターゲットディレクトリ内にサイトを作成しました。

ドキュメントサイトページ

C：\ MVN \ consumerBanking \ target \ siteフォルダーを開きます。 ドキュメントを表示するには、indexlをクリックしてください。

消費者ウェブページ

Mavenは、複数のソース形式を共通のドキュメントモデルに読み込むhttps://maven.apache.org/doxia/indexl[Doxia]と呼ばれるドキュメント処理エンジンを使用してドキュメントを作成します。 プロジェクトのドキュメントを作成するには、Doxiaによって解析される一般的に使用される以下のいくつかの形式でコンテンツを作成できます。

フォーマット名

説明

参照

XDoc

Maven 1.xドキュメント形式

https://jakarta.apache.org/site

FML

FAQドキュメントに使用

https://maven.apache.org