使用maven打包生成doc文档和打包源码的完整攻略如下:
一、生成文档
- 添加maven插件:在pom.xml文件中,添加以下插件:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<excludePackageNames>com.example.test.priv</excludePackageNames>
</configuration>
</plugin>
</plugins>
</build>
其中,excludePackageNames指的是需要排除的包路径。
- 执行命令生成文档:在项目根目录下,执行以下命令生成文档:
mvn javadoc:javadoc
执行成功后,在target/site/apidocs目录下会生成html形式的API文档。
示例一:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<excludePackageNames>com.example.test.priv</excludePackageNames>
</configuration>
</plugin>
</plugins>
</build>
执行命令:
mvn javadoc:javadoc
生成的文档路径为:target/site/apidocs
二、打包源码
- 添加maven插件:在pom.xml文件中,添加以下插件:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
<configuration>
<attach>true</attach>
</configuration>
</plugin>
</plugins>
</build>
其中,attach为true表示打包时需要附加源码。
- 执行命令打包源码:在项目根目录下,执行以下命令打包源码:
mvn source:jar
执行成功后,在target目录下会生成一个以源码形式打包的jar文件。
示例二:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
<configuration>
<attach>true</attach>
</configuration>
</plugin>
</plugins>
</build>
执行命令:
mvn source:jar
生成的源码包路径为:target/项目名称-version-sources.jar
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:使用maven打包生成doc文档和打包源码 - Python技术站