配置 Checkstyle 以忽略一般警告答案

【问题标题】：Configuring Checkstyle to ignore generic warnings配置 Checkstyle 以忽略一般警告
【发布时间】：2013-06-20 16:52:51
【问题描述】：

我正在开发一个项目并使用 checkstyle 来验证项目的 javadocs。我不想要任何 checkstyle javadoc 警告。

但是 checkstyle 给了我以下与泛型有关的不需要的警告：

'' 的预期 @param 标记。

有什么方法可以关闭或取消此特定警告吗？

我遇到的唯一方法是禁止对我不想做的特定行发出警告。

有谁知道配置 checkstyle 以忽略一般警告的方法？

【问题讨论】：

【解决方案1】：

您可以通过将allowMissingParamTags 属性设置为true 来配置JavadocType 检查的这种行为，如下所示：

<module name="JavadocType">
    <property name="allowMissingParamTags" value="true"/>
</module>

在我的 Eclipse checkstyle 插件版本 (5.6.0.201209221626) 上，这个选项不知何故在 GUI 中不存在（错误？），但可以通过直接编辑 XML 来设置。

【讨论】：

感谢您的回复。事实证明，我不需要这样做，因为我毕竟想查看错误。但是出于好奇，如果我按照您的建议进行操作，是否不会关闭所有缺少 Javadoc 标记的警告？我仍然希望看到所有其他丢失的参数标签。只是不是通用的。你明白我从哪里来吗？也许这是不可能的？
@Kevin 是的，这只会影响您的泛型类型参数，因为它是在 JavadocType 检查中设置的，它不知道其他参数。 JavadocMethod 不受影响（如果您有具有泛型参数的方法，这可能是一个“问题”）。