java - 禁止通过 Checkstyle 进行多行注释

Question

想知道是否有特定的规则或属性会使 Checkstyle(版本 6.5+)在存在多行注释的情况下出错，如下所示:

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

我相信拥有特定的正则表达式模式规则可能是一种选择，但很好奇 Checkstyle 是否已经拥有可以实现这一目的的专用规则/属性。

Answer 1

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

这可以通过 IllegalToken 来完成.

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

虽然不是明确的，但如果您仍然想允许 Javadoc(只是特殊的 block 注释)，则必须使用 xpath 抑制来允许它们并禁止其他注释。请参阅SuppressionXpathFilter .