java - Checkstyle RegexpHeader 未正确检测正则表达式

Question

我正在尝试为代码文件在代码库中的开始方式添加一个 checkstyle 配置。我想要的格式可以用java中的一个模式来描述——^package.*\n\n.*。但是，当我将它与 RegexpHeader 一起使用时，这种模式似乎不起作用。这是我的配置-

<module name="RegexpHeader">
    <property name="header" value="^package .*\n\n.*"/>
    <property name="fileExtensions" value="java"/>
</module>

而且它似乎并没有因此而失败-

package my.checkstyle.frustrations;
/**
 * Hello world!
 *
 */
public class ShouldFail
{
}

我创建了一个示例项目 here .

Answer 1

看来这张支票不应该按照我的方式使用。它应该仅用于标题，在文件中的任何代码(包括包声明)之前。然而，我确实通过将我的正则表达式更改为 ^package\n^$ 来破解它以使其适用于我的用例。

我还尝试将 EmptyLineSeparatorCheck 与 PACKAGE_DEF 标记一起使用，但它也不起作用，因为该检查忽略了注释行。如果有人知道我可以使用的适用于我的用例的另一项检查，请告诉我。