配置Checkstyle以忽略常规警告

时间:2013-06-24 08:33:19

标签: java generics javadoc checkstyle suppress-warnings

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

然而checkstyle给了我以下关于泛型的不必要的警告:

  

'<的预期@param标记T> ”。

有没有办法可以关闭或禁止此特定警告?

我遇到这种情况的唯一方法是抑制我不想做的特定行的警告。

任何人都知道配置checkstyle以忽略通用警告的方法吗?

1 个答案:

答案 0 :(得分:0)

您可以通过将allowMissingParamTags属性设置为true来配置JavadocType检查的此行为,如下所示:

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

在我的Eclipse checkstyle插件版本(5.6.0.201209221626)上,此选项在GUI中不存在(bug?),但可以通过直接编辑XML来设置。