在checkstyle中是否可以仅在类上存在时验证类的javadoc

时间:2017-05-22 14:21:13

标签: java checkstyle

我希望checkstyle只在它出现时验证类的javadoc,所以没有警告javadoc缺失。

对于方法的javadoc,可以使用allowMissingJavadoc参数,但是我没有看到JavadocType模块的等效项。

谢谢!

2 个答案:

答案 0 :(得分:0)

如果您将Eclipse与Checkstyle插件一起使用,请执行以下操作:

编辑Checkstyle配置文件。转到“Javadoc Comments”,选择“Method Javadoc”并单击“Open”。 你有很多选择规则。检查“allowMissingJavadoc”应该做你想要的。

如果您使用的是没有Eclipse的Checkstyle,那么也应该可以进行配置。我不熟悉它,但这应该给你一个提示要寻找的东西。

答案 1 :(得分:0)

  

对于方法的javadoc,可以使用allowMissingJavadoc参数,但我没有看到JavadocType模块的等效项。

现在使用当前的Checkstyle,这是不可能的。 JavadocTypehttp://checkstyle.sourceforge.net/config_javadoc.html#JavadocType)没有这样的属性或任何好的替代方法来实现它。

我建议您在https://github.com/checkstyle/checkstyle/issues/new提交功能请求,要求将其付诸实施。