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的標準目錄佈局

回答

相關問題