0316-Java学习-093-【答疑解惑】MavenReportException: Error while generating Javadoc

 

一、问题描述

在使用 IDEA 二次开发 jacoco 进行编译源代码，生成 doc 文档时，控制台报错，错误信息截图如下：

 对应的日志文本信息如下所示：

[INFO] root ............................................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  12.518 s
[INFO] Finished at: 2022-11-01T09:14:20+08:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (attach-javadocs) on project org.jacoco.core: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:37: 警告: @param 没有说明
[ERROR]          * @param className
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:54: 警告: @param 没有说明
[ERROR]          * @param className
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:55: 警告: @param 没有说明
[ERROR]          * @param methodName
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:58: 警告: desc没有 @param
[ERROR]         public static Boolean checkMethodIn(String className, String methodName,
[ERROR]                               ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:99: 警告: @return 没有说明
[ERROR]          * @return
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:21: 错误: 未知标记: ProjectName
[ERROR]  * @ProjectName: root
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:22: 错误: 未知标记: Package
[ERROR]  * @Package: org.jacoco.core.internal.diff
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:23: 错误: 未知标记: Description
[ERROR]  * @Description: 差异代码处理类
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:24: 错误: 未知标记: Author
[ERROR]  * @Author: duanrui
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:25: 错误: 未知标记: CreateDate
[ERROR]  * @CreateDate: 2021/1/12 15:17
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\CodeDiffUtil.java:26: 错误: 未知标记: Version
[ERROR]  * @Version: 1.0
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:31: 警告: @param 没有说明
[ERROR]          * @param filePath
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:32: 警告: @return 没有说明
[ERROR]          * @return
[ERROR]            ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:19: 错误: 未知标记: Package
[ERROR]  * @Package: org.jacoco.core.internal.diff
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:20: 错误: 未知标记: Description
[ERROR]  * @Description: json 读取
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:21: 错误: 未知标记: Author
[ERROR]  * @Author: rayduan
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:22: 错误: 未知标记: CreateDate
[ERROR]  * @CreateDate: 2021/11/23 10:48 上午
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:23: 错误: 未知标记: Version
[ERROR]  * @Version: 1.0
[ERROR]    ^
[ERROR] D:\office\code_personal\jacoco\org.jacoco.core\src\org\jacoco\core\internal\diff\JsonReadUtil.java:24: 警告: <p> 标记为空
[ERROR]  *           <p>
[ERROR]              ^
[ERROR]
[ERROR] Command line was: C:\Java\jdk1.8.0_181\jre\..\bin\javadoc.exe @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in 'D:\office\code_personal\jacoco\org.jacoco.core\target\apidocs' dir.
[ERROR]
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.

 

 

二、问题分析

在使用maven打包时报MavenReportException: Error while generating Javadoc错误，这个是由于jdk8之后javadoc工具默认是开启doclint来检查注释格式的，一般我们写注释都不是完全遵循该规范，所以需要在maven中关闭该检查。

添加-Xdoclint:none便可关闭检查。“-Xdoclint:none”只是JDK 8中有的，如果使用的是JDK 8之前的版本，一定不能有这个，否则maven跑不过。 所以我们可以借助profile激活条件来限制区分。

 

三、解决问题

3.1、maven-javadoc-plugin小于3.0.0

 

 

3.2、maven-javadoc-plugin大于3.0.0 

 

3.3、使用以下命令进行 install