通過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>

盡管它不是很明確，但是如果您仍然希望允許Javadoc（它們只是特殊的塊注釋），則必須使用xpath抑制來允許它們並禁止其他對象。 請參閱SuppressionXpathFilter 。