2016-07-22 4 views
1

Я следую за Maven's Standard Directory Layout для моего проекта.Checkstyle и стандартный каталог макетов Maven

Есть ли предпочтительный каталог, чтобы поместить мой файл checkstyle.xml? Я видел это по крайней мере 3 возможных местах:

  • SRC/главная/ресурсы/checkstyle.xml
  • SRC/главная/Checkstyle/checkstyle.xml - Пример: Joda-Time
  • SRC/Checkstyle/checkstyle.xml - Пример: Spring Boot

Поскольку это в основном файл для разработчиков, первый вариант вызывает у меня сомнения. Имеет ли смысл включать checkstyle.xml в JAR-файл?

Спасибо,

Федя

+1

'src/main/resources' не имеет смысла, потому что он копируется во время процесса сборки и может быть (на основе конкретной конфигурации отфильтрован), что не является хорошей идеей ... Я бы предложил поместить его в' src/checkstyle' ... одним из правил является то, что все, что находится в 'src/main /', будет упаковано ... что не обязательно для правил checkstyle? – khmarbaise

+0

О, так что мои сомнения относительно первого варианта будут также применяться ко второму (файл checkstyle будет упакован). В этом есть смысл. Добавьте это как ответ, и я приму это. Спасибо. – federicojasson

ответ

1

checkstyle.xml Ввода в src каталоге не имеет смысла, так как она не является частью исходного кода.

Наиболее распространенное соглашение, которое я наблюдал в своих проектах, заключается в его размещении в config/checkstyle/checkstyle.xml. Тысячи проектов используют его (filename:checkstyle.xml path:config/checkstyle), а Gradle использует это место by default.

+0

Я не знал этого о Gradle. спасибо – federicojasson

 Смежные вопросы

  • Нет связанных вопросов^_^