我正在开发一个项目,并使用 checkstyle 来验证该项目的 javadoc。我不想要任何 checkstyle javadoc 警告。
然而,checkstyle 给了我以下与泛型有关的不需要的警告:
Expected @param tag for '< T > '.
有什么方法可以关闭或抑制此特定警告吗?
我遇到的这样做的唯一方法是抑制我不希望执行的特定行的警告。
有人知道配置 checkstyle 来忽略一般警告的方法吗?
最佳答案
您可以配置 JavadocType 的此行为通过将 allowMissingParamTags
属性设置为 true
进行检查,如下所示:
<module name="JavadocType">
<property name="allowMissingParamTags" value="true"/>
</module>
在我的 Eclipse checkstyle 插件版本 (5.6.0.201209221626) 上,此选项不知何故不存在于 GUI 中(bug?),但可以通过直接编辑 XML 来设置。
关于java - 配置 Checkstyle 以忽略一般警告,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17271130/