مستندات مشروع 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]　Building　consumerBanking
[INFO]task-segment:　[site]
لفتح
[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]　الوقت الإجمالي: 16 ثانية
لفتح
[INFO]　انتهاء الوقت: الأثنين 11 تموز 18:11:18 IST 2012
[INFO]　الذاكرة النهائية: 23M/148M
[INFO]　-------------------------------------------------------------------
لفتح

C:\MVN\consumerBanking\target\site انقر على في مجلد. index.html لرؤية المستند.

يستخدم Maven وحدة تحكم تُدعى Doxiaمستند معالجة المستندات يمكنه إنشاء نموذج مستند عام من مصادر متعددة الأنماط. إذا كنت تريد كتابة مستند لمشروعك، يمكنك كتابة المحتوى في أحد هذه الأنماط الشائعة التي يمكن تحويلها بواسطة Doxia.