Чтобы обеспечить последовательное форматирование ваших проектов, вам необходимо настроить инструменты, чтобы сделать это автоматически. Я хотел бы предложить следующее:
Затмение Formatter
Для Eclipse, есть опция в настройках (Java-> Код Стиль-> Formatter), где вы можете настроить, как вы хотите, чтобы ваши проекты должны быть отформатированы. Создайте новый профиль и разместите там свою конфигурацию.
Как только вы закончите, существует функция экспорта (она хорошо скрыта, нажмите «Изменить», а затем «Экспорт»). Передайте конфигурацию остальной части команды, чтобы ее можно было импортировать.
Затмения Сохранить действия
Тем не менее, имеющий форматировщик сконфигурированный не гарантирует, что разработчики будут форматировать код перед тем, так что вам нужно настроить автоматический формат.
Вернитесь к настройкам еще раз (Java-> Редактор-> Сохранить действия) и выберите Формат исходного кода. Таким образом, код форматируется при сохранении файла.
Затмение Checkstyle Плагин
Некоторые разработчики могут забыть сделать эти шаги правильно, так что вам нужен способ, чтобы найти это.
Установите плагин Checkstyle для Eclipse:
После установки плагина, вы можете создать для него конфигурацию. Конфигурация затем может быть экспортирована для остальной части команды или даже лучше загружена на сервер и удалена с удаленной ссылкой на конфигурацию.
Преимущество наличия удаленной конфигурации заключается в том, что вы также можете ссылаться на нее с помощью maven-checkstyle-plugin, и он может предоставить вам отчеты, запустив их на сервере CI.
Если вы хотите быть жестким ядром, вы можете установить базовую конфигурацию (автоматически выполняемую форматированием) на ошибки вместо предупреждений, чтобы разработчик с неправильно сконфигурированным затмением увидел ошибку перед совершением.
Предварительно настроенные Затмения
Если вы хотите, чтобы перейти на следующий уровень, необходимо создать предварительно сконфигурированные затмение, и распространять эту версию для ваших разработчиков, так что им не нужно ничего делать.
Бонус с побочным эффектом: вы не согласны с версией на платформе разработки. Управление конфигурацией относится не только к исходному коду, но и к инструментам разработки. Сохраняет вещи более предсказуемыми.
Я видел, как это терпело неудачу несколько раз. Мне гораздо легче отслеживать/применять правила, если он интегрирован в процесс автоматической сборки, используя Maven/Checkstyle/Hudson. –
Я не предлагал, чтобы это было единственное, что вы делали. Вы обязательно должны использовать Checkstyle - это упростит исправление форматирования во время написания кода, а не после факта. –
В этом случае я бы предложил использовать плагин Checkstyle Eclipse и настроить его на использование тех же правил, что и Hudson. –