通过Checkstyle禁止多行评论

Question

想知道是否存在特定的规则或属性，如果在多行注释的情况下会导致Checkstyle（版本6.5及更高版本）出错，

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

我相信可以使用特定的Regex模式规则，但对Checkstyle是否已经具有可以解决问题的专用规则/属性感到好奇。

Answer 1

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

这可以通过IllegalToken完成。

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

尽管它不是很明确，但是如果您仍然希望允许Javadocs（只是特殊的块注释），则必须使用xpath抑制来允许它们并禁止其他对象。参见SuppressionXpathFilter。