Maven 生成 Javadoc 文档出错:原因与解决方案
使用 maven-javadoc-plugin 生成 Javadoc 时,经常会因注释不规范导致构建失败(如缺少参数说明、标签格式错误)。本文将详解错误原因,并提供多种解决方案,帮助顺利生成文档。
错误原因分析
Javadoc 工具对注释规范性要求严格,常见错误包括:
@param/@return/@throws标签缺失或与实际参数不匹配。- 注释中使用未闭合的 HTML 标签(如
<p>未闭合)。 - 特殊字符未转义(如
&需写成&)。 - 方法 / 类注释为空但使用了 Javadoc 格式(
/** ... */)。
当 maven-javadoc-plugin 检测到这些问题时,会默认将警告视为错误,导致构建失败(如 Exit code: 1)。
解决方案
1. 忽略注释检查(快速解决)
通过配置 doclint 参数禁用 Javadoc 的语法检查,忽略所有注释不规范的警告: