Checkstyle和Maven的标准目录布局

我正在关注我的项目的Maven的Standard Directory Layout。Checkstyle和Maven的标准目录布局

有没有一个首选的目录把我的checkstyle.xml文件？我已经看到了它在至少3个可能的位置：

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

因为这主要是开发人员的文件，所以第一个选项给了我怀疑。将checkstyle.xml包含到JAR文件中是否有意义？

感谢，

菲德

2016-07-22 federicojasson

'src/main/resources'没有意义，因为它在构建过程中被复制，并且可能（基于特定配置过滤），这不是一个好主意......我建议将它放入' src/checkstyle“...其中一条规则是，src/main /中的所有内容都将被打包...这对于checkstyle规则来说不是必需的吗？ – khmarbaise

哦，所以我对第一个选项的犹豫也适用于第二个选项（checkstyle文件将被打包）。这就说得通了。添加这个作为答案，我会接受它。谢谢。 – federicojasson

在src目录把checkstyle.xml并没有真正意义，因为它不是源代码的一部分。

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

来源

2016-07-27 22:04:16

我不知道关于Gradle。谢谢 – federicojasson

Checkstyle和Maven的标准目录布局

回答

相关问题