2013-06-24 75 views
1

我正在使用checkstyle来验证项目的javadoc。我不想要任何checkstyle javadoc警告。配置Checkstyle以忽略一般警告

但是CheckStyle的是给我下面的不必要的警告做仿制药:

预计为 '< T>' @param标签。

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

我遇到过这样做的唯一方法是压制针对特定行的警告,我不想这样做。

任何人都知道配置checkstyle忽略一般警告的方法吗?

回答

0

您可以通过设置allowMissingParamTags属性配置JavadocType检查这种行为true像这样:

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

在我的版本的Eclipse插件的CheckStyle(5.6.0.201209221626)的,这个选项是某种不存在在GUI(bug?)中,但可以通过直接编辑XML来设置它。

+1

感谢您的回复。事实证明,我不需要这样做,因为我想看到错误毕竟。 但是出于好奇,如果我这样做了,就像你建议将不会关闭所有缺少Javadoc标签的警告?我仍然想看到所有其他缺少的param标签。只是不是通用的。 你明白我来自哪里吗?也许这是不可能的? – Kevin

+0

@Kevin是的,这只会影响你的泛型类型参数,因为它设置在* JavadocType *检查上,它不知道其他参数。 * JavadocMethod *不受影响(如果您使用泛型参数的方法,这可能是一个“问题”)。 –