Checkstyle和Maven的标准目录布局

Question

我正在跟随Maven Standard Directory Layout参与我的项目。

是否有一个首选目录来放置我的checkstyle.xml文件？我在至少3个可能的位置看过它：

• 的src /主/资源/ checkstyle.xml
• src / main / checkstyle / checkstyle.xml - 示例：Joda-Time
• src / checkstyle / checkstyle.xml - 示例：Spring Boot

由于这主要是开发人员的文件，第一个选项让我怀疑。将checkstyle.xml包含在JAR文件中是否有意义？

谢谢，

菲德

Answer 1

将checkstyle.xml放在src目录中并不合理，因为它不是源代码的一部分。

我在项目中观察到的最常见的约定是将其放入config/checkstyle/checkstyle.xml。成千上万的项目使用它（filename:checkstyle.xml path:config/checkstyle），Gradle使用此位置by default。