У каждой компании есть свой стандарт оформления кода и важно придерживаться его. Встроенные в IDE форматеры кода решают это задачу частично, так как они в основном позволяют лишь добиться простого выравнивая кода. Помимо этого хочется еще и порядка в последовательности объявления как полей, методов, так и вложенных классов. Причин, по которым код-стандарт не соблюдается масса: программист перед отправкой кода в репозиторий может не заметить отклонение от стандарта; новый разработчик недостаточно внимательно прочитал документ; в погоне за хот фиксом о формате забыли; либо из-за банальной усталости или лени программиста; автоматического рефакторинга и так далее. Регулярный код-ревью не решает суть проблемы, так как занимает слишком много времени и тормозит разработку — нужна автоматизация проверки соответствия кода в момент его написания!Частые проблемы:
- конструктор неожиданно появляется в середине класса;
- внутренний класс объявлен где-то в середине внешнего класса;
- абстрактный метод объявлен где-то в середине большого абстрактного класса;
- @Autowired метод тоже расположен где угодно но только не на самом видном месте;
- статические билдер методы разбросаны по коду класса;
- поле класса затерялось где-то между внутренним классом и методами.