java - 如何禁用构造函数的 checkstyle JavaDoc 验证？

Question

如何禁用构造函数的 checkstyle JavaDoc 验证？

我看到了 http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod明确指出它“检查方法或构造函数的 Javadoc”，但是我需要排除构造函数并只保留方法。

Answer 1

为了忽略构造函数，删除 CTOR_DEF来自 tokens 的 token 属性，例如:

<module name="JavadocMethod">
  <property name="tokens" value="METHOD_DEF,ANNOTATION_FIELD_DEF"/>
</module>

这是通过设置 tokens 来实现的。除了 CTOR_DEF 之外的所有其他允许的 token .不幸的是，要使其正常工作，您需要知道要设置哪些标记，并且此列表因 Checkstyle 版本而异，并且并不总是准确反射(reflect)在 docs 中。 .上面的这个例子应该提供一个合理的设置。