使用maven插件生成项目的java doc

一时失言乱红尘 2022-05-31 03:45 276阅读 0赞

**操作步骤：**

1. 在pom.xml文件中添加javadoc配置

<profiles>
    	<profile>
    		<id>doclint-java8-disable</id>
    		<activation>
    			<jdk>[1.8,)</jdk>
    		</activation>
    
    		<build>
    			<plugins>
    				<plugin>
    					<groupId>org.apache.maven.plugins</groupId>
    					<artifactId>maven-javadoc-plugin</artifactId>
    					<configuration>
    						<additionalparam>-Xdoclint:none</additionalparam>
    					</configuration>
    				</plugin>
    			</plugins>
    		</build>
    	</profile>
    </profiles>

2. 在mvn命令行中执行命令生成api文档

mvn javadoc:javadoc

**乱码解决方案:**

1. 如果报出"编码GBK的不可映射字符"的错误，在pom.xml文件中添加如下编码配置:

2. 如果控制台乱码

File -> Settings -> Build, Execution, Deployment | Build Tools | Maven | Runner，在VM Options中，填入：

-Dfile.encoding=GBK

再次执行该命令前，使用 **mvn clean**命令清除掉之前生成的乱码文档，否则还是使用之前的UTF-8格式编码

**参考链接：**

[IntelliJ IDEA使用maven-javadoc-plugin生成Java Doc控制台乱码][IntelliJ IDEA_maven-javadoc-plugin_Java Doc]

[Java 8 配置Maven-javadoc-plugin][Java 8 _Maven-javadoc-plugin]

[Maven is not working in Java 8 when Javadoc tags are incomplete][]

[IntelliJ IDEA_maven-javadoc-plugin_Java Doc]: http://codepub.cn/2016/05/06/IntelliJ-IDEA-using-maven-javadoc-plugin-to-generate-the-Java-Doc-console-gibberish/
[Java 8 _Maven-javadoc-plugin]: http://codepub.cn/2016/10/18/Java-8-configure-maven-java-doc-plugin/
[Maven is not working in Java 8 when Javadoc tags are incomplete]: https://stackoverflow.com/questions/15886209/maven-is-not-working-in-java-8-when-javadoc-tags-are-incomplete