Checkstyle 和 Maven 的标准目录布局
Checkstyle and Maven's Standard Directory Layout
我正在为我的项目关注 Maven 的 Standard Directory Layout。
是否有首选目录来放置我的 checkstyle.xml 文件?我至少在 3 个可能的位置看到过它:
- src/main/resources/checkstyle.xml
- src/main/checkstyle/checkstyle.xml - 示例:Joda-Time
- src/checkstyle/checkstyle.xml - 示例:Spring Boot
由于这主要是开发人员的文件,所以第一个选项让我怀疑。将 checkstyle.xml 包含到 JAR 文件中有意义吗?
谢谢,
联邦
将 checkstyle.xml
放入 src
目录没有任何意义,因为它不是源代码的一部分。
我在我的项目中观察到的最常见的约定是将其放入 config/checkstyle/checkstyle.xml
。数以千计的项目使用它 (filename:checkstyle.xml path:config/checkstyle) and Gradle uses this location by default。
我正在为我的项目关注 Maven 的 Standard Directory Layout。
是否有首选目录来放置我的 checkstyle.xml 文件?我至少在 3 个可能的位置看到过它:
- src/main/resources/checkstyle.xml
- src/main/checkstyle/checkstyle.xml - 示例:Joda-Time
- src/checkstyle/checkstyle.xml - 示例:Spring Boot
由于这主要是开发人员的文件,所以第一个选项让我怀疑。将 checkstyle.xml 包含到 JAR 文件中有意义吗?
谢谢,
联邦
将 checkstyle.xml
放入 src
目录没有任何意义,因为它不是源代码的一部分。
我在我的项目中观察到的最常见的约定是将其放入 config/checkstyle/checkstyle.xml
。数以千计的项目使用它 (filename:checkstyle.xml path:config/checkstyle) and Gradle uses this location by default。