通过 Checkstyle 禁止多行注释

Question

想知道是否存在特定规则或属性会导致 Checkstyle（版本 6.5+）在出现多行注释时出错，如：

/*
 a multi-line comment, could Checkstyle detect them?
*/
public Foo bar() {
    ...
}

我相信有一个特定的 Regex 模式规则可能是一种选择，但我想知道 Checkstyle 是否已经有一个专用的 rule/property 可以做到这一点。

Answer 1

从你的问题中不清楚，但我假设你想禁止所有多行注释，而不仅仅是它们的特定样式。

这可以通过 IllegalToken 来完成。

<module name="IllegalToken">
  <property name="tokens" value="BLOCK_COMMENT_BEGIN"/>
</module>

虽然没有明确说明，但如果您仍想允许 Javadocs，它们只是特殊的块注释，您将不得不使用 xpath 抑制来允许它们并禁止其他的。参见 SuppressionXpathFilter。

Disallow Multi-Line Commenting via Checkstyle