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

操作步骤:

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文件中添加如下编码配置:

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
</properties>
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控制台乱码

Java 8 配置Maven-javadoc-plugin

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值