配置 gradle build 以抑制 javadoc 控制台警告答案

【问题标题】：Configure gradle build to suppress javadoc console warnings配置 gradle build 以抑制 javadoc 控制台警告
【发布时间】：2019-02-11 18:49:34
【问题描述】：

我正在使用 gradle 的 javadoc plugin 配置 gradle 构建。由于 javadoc lint 错误，我能够阻止构建失败，但是对于那些我不关心的 lint 错误，仍然有数百行控制台输出。

任何想法如何抑制这些与 linting 相关的控制台消息？

我正在谈论的示例输出（但屏幕和屏幕已满）：

/home/user/projects/my-project/src/main/java/my/package/MyObject.java:89: warning: no description for @param
     * @param myParam
       ^
/home/user/projects/my-project/src/main/java/my/package/MyObject.java:90: warning: no description for @return
     * @return
       ^
/home/user/projects/my-project/src/main/java/my/package/MyObject.java:101: warning: no @param for itemId
    List<MyItem> getMyItems(Long itemId);
                        ^

我应该澄清一下，我正在构建配置中寻找解决方案，而不是每次运行时传递给 gradle build 命令的标志。

【问题讨论】：

只需修复 javadoc 注释。
@MartinZeitler 虽然注意 lint 警告会解决问题，但我认为这样做不是最佳实践。他们希望为每个参数、返回值等提供文档。对于一些公共项目，这可能是最好的，但对于我公司内部的项目，我认为这些警告会鼓励浪费精力和臃肿的文档。

标签： gradle javadoc

【解决方案1】：

可以使用 Xdoclint 选项抑制警告/错误：

javadoc.options.addStringOption('Xdoclint:none', '-quiet')

这仍会显示一些最严重的警告，但会删除其中的绝大多数。

见：https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html

顺便说一句，根据 gradle javadoc 文档，您可以直接设置输出级别（VERBOSE 或 QUIET）。问题是 QUIET 仍然显示所有警告和错误消息，而且似乎是默认行为。

【讨论】：

【解决方案2】：

您可以在 javadoc 任务的options 块内设置outputLevel，但不幸的是，即使QUIET 级别对您来说也不够

关闭非错误和非警告消息，只留下出现警告和错误，使其更易于查看。

所以使用提供的任务设置，我认为你被卡住了。

其他解决方案：修复您的 javadoc 问题。

【讨论】：