如何在 javadoc 编译期间抑制警告（代码库范围内）？

Question

我被困在一个遗留的 Java 代码库中，当你编译它时，它有数千个警告。 我很想真正修复所有这些警告的来源，但不幸的是，目前在我的公司这不是一个选择（负责人认为“制造可产生收入的新产品”等其他事情被认为是更优先的事情；想象一下） 。

现在，如果不是因为它们使我们很难在连续构建服务器的输出中找到实际错误，我可以忍受所有这些警告。 构建服务器只使用 ant 调用，没什么花哨的，但到目前为止我还没有在任何地方找到任何关于如何修改此调用以防止警告输出的信息。

浏览代码并在各处添加 @SuppressWarnings 注释是可行的，但它也几乎与浏览并修复所有警告来源一样痛苦。 所以我真正喜欢的是如果有某种方法我可以做：

<javadoc suppressWarrnings="true"

或类似的事情，使 javadoc 编译器不输出所有警告消息。 像这样的事情（全局 javadoc 警告禁用）可能吗？

Answer 1

如今，一些 javadoc 非标准选项允许您避免过多的错误和/或警告。 查看javadoc的帮助（执行javadoc -X）； 应提供以下非标准选项：

-Xmaxerrs <number>
-Xmaxwarns <number>              
-Xdoclint:(all|none|[-]<group>)

-Xmaxerrs 设置要打印的最大错误数
-Xmaxwarns 设置要打印的最大警告数
-Xdoclint 启用或禁用对 javadoc 注释中问题的特定检查。

例如，指定 -Xdoclint:none 将禁用对 javadoc 注释中大多数问题的特定检查； 并且 -Xmaxwarns 1 会将警告数量限制为 1 （我尝试了 -Xmaxwarns 0，但随后它打印了所有警告，所以我的猜测是 0 表示没有限制）

Answer 2

马克的回答对我来说听起来不错，并且对于不使用 Cruise Control 持续构建系统的任何人来说可能都非常有用。 然而，我发现对于任何使用该系统的人（像我一样）来说，还有另一种方法。

Cruise control 使用多个 XSLT 样式表来组装其报告。 在我们的例子中，这些样式表位于：

~/applications/cruisecontrol-bin-2.7.3/webapps/cruisecontrol/xsl

但由于我没有设置我们的安装，我不知道这是否是标准路径。 无论如何，您应该能够在安装中找到等效的目录。 该目录中有一个名为errors.xsl 的文件。 要消除警告，您需要对该文件进行两项更改，这两项更改都涉及注释现有规则。

将：替换

<xsl:variable name="total.errorMessage.count" select="count($warn.messages) + count($error.messages)"/>

为：

<!--        <xsl:variable name="total.errorMessage.count" select="count($warn.messages) + count($error.messages)"/>-->
<xsl:variable name="total.errorMessage.count" select="count($error.messages)"/>

这将使“错误计数”成为实际错误的计数，而不是错误+警告的​​计数。

然后，将： 替换

<xsl:template match="message[@priority='warn']" mode="errors">
    <xsl:if test="not(starts-with(text(),'cvs update'))">
        <xsl:value-of select="text()"/><br class="none"/>
    </xsl:if>
</xsl:template>

为：

<!--<xsl:template match="message[@priority='warn']" mode="errors">
    <xsl:if test="not(starts-with(text(),'cvs update'))">
        <xsl:value-of select="text()"/><br class="none"/>
    </xsl:if>
</xsl:template>-->

这将隐藏实际的警告本身。 或者，您始终可以删除注释掉的代码，但是您应该首先备份该文件，以防万一您想恢复警告。 此外，XSLT 会忽略任何非 XSLT 标记，因此除了完全消除警告之外，您还可以对警告执行其他操作：例如，您可以将所有警告包装在 DIV 中，然后使用 CSS/Javascript 来“折叠”警告而不是完全删除它们。

虽然我最终不得不自己发现这个解决方案，但这里的所有答案都帮助我理解了发生了什么，所以感谢大家的帮助。

Answer 3

我刚刚发现我在之前的答案中描述的内容有一个稍微更好的变体。 不要编辑errors.xsl，而是编辑buildresults.xsl。 该文件包含一条注释：

for traditional cc display of only compile errors and warnings
comment out mode="errors" and uncomment mode="compile" and mode="javadoc"

如果您遵循该注释的建议（注释掉它提到的两行并取消注释它提到的一行），您将获得完全相同的效果，但会包含编译错误。

为什么要使用这种方法而不是我以前的方法呢？ 好吧，我认为（我真的应该更好地测试这个，但我很懒）我以前的方法会出现编译错误； 此方法保留它们。

Answer 4

在 Java 8 中，您可以将 additionalparam="-Xdoclint:none" 添加到 javadoc 任务。 （来源）

Answer 5

尝试使用 -quiet 标志。

Answer 6

ant 任务和 javadoc 工具本身都无法全局禁用警告。

我能想到的一种可能的解决方法是将 javadoc 任务作为与构建的其余部分分开的 ant 调用来运行。 您可以使用 ant 的 -logfile 参数将输出重定向到日志文件而不是控制台。