1、如何生成项目文档
为了让您从Maven的文档系统开始,您可以使用以下命令使用原型机制来为您的现有项目生成一个站点:
mvn archetype:generate \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DarchetypeArtifactId=maven-archetype-site \
-DgroupId=com.mycompany.app \
-DartifactId=my-app-site
创建站点的第一步是创建一些内容。在Maven中,站点内容由格式分隔开,因为有几个可用的格式。
+- src/
+- site/
+- apt/
| +- index.apt
!
+- markdown/
| +- index.md
|
+- xdoc/
| +- other.xml
|
+- fml/
| +- general.fml
| +- faq.fml
|
+- site.xml
您将注意到现在有一个$basedir/src/site
目录,其中包含一个站点描述符以及与受支持的文档类型对应的各种目录。让我们看一下站点描述符和各种文档类型的例子。
APT格式,“几乎是纯文本”,是一种类似于wiki的格式,允许您编写简单、结构化的文档(像这样的文档)。可用的适当格式的完整引用。
FML格式是FAQ格式。
其他的格式是可用的,但是在这一点上,这3个是最好的测试。也有几种可能的输出格式,但是在2.0中,只有XHTML可用。
注意,上面的所有内容都是可选的——在一个输入树中只需要一个索引文件。每个路径将被合并到一起形成站点的根目录。
生成站点非常简单,而且速度很快!
mvn site
源代码可以查看这里的链接:
2、构建其他类型的项目
注意,生命周期适用于任何项目类型。例如,回到基本目录中,我们可以创建一个简单的web应用程序:
mvn archetype:generate \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DarchetypeArtifactId=maven-archetype-webapp \
-DgroupId=com.mycompany.app \
-DartifactId=my-webapp
注意,这些都必须在一行中。这将创建一个名为my-webapp
的目录,其中包含以下项目描述符:
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mycompany.app</groupId>
<artifactId>my-webapp</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<finalName>my-webapp</finalName>
</build>
</project>
注意<packaging>
元素-这告诉Maven构建一个WAR
包。切换到webapp
项目的目录并尝试:
mvn package
你会看到target/my-webapp.war
建立了,所有正常的步骤都被执行了。
源代码可以查看这里的链接: