От автора: в IntelliJ IDEA форматирование кода придает приложению характерную стройность и читабельность. Необходимо помнить — все, что вы написали, когда-то будет совершенствовать кто-то еще. И ни одна функциональность не украсит программиста так, как удобочитаемость его творения. Поэтому сегодня разберемся с тем, как форматировать код, и дадим пару дельных советов. Вы научитесь выравнивать его так, чтобы он и выглядел профессионально, и громко говорил о ваших навыках.
С чего начать
Важным аспектом стиля является то, как форматировать код: как применять пробелы и пустые строки для структуризации и разделения блоков, нужно ли использовать вкладки для отступов и как переносить длинные строки.
Обширный набор правил форматирования ReSharper имеет конфигурацию по умолчанию, которая учитывает параметры структуризации в самой IDEA, а также многочисленные рекомендации.
Автоформатирование отредактированного и вставленного кода
ReSharper также позволяет автоматически применять правила при вставке. По умолчанию, вставленный код изменяется не полностью, а применяются только настройки отступа. Если вы хотите полностью подогнать или отключить форматирование при вставке, используйте переключатель «Автоформатирование при вставке» в среде.
Обратите внимание, что по умолчанию IDEA применяет свои собственные правила для отредактированного и вставленного кода. Если вы используете функции автоматического форматирования ReSharper, рекомендуем отключить их. Вы можете сделать это в настройках.
Параметры стиля подразделяются на следующие категории:
вкладки и отступы: конфигурация для отступа, отступы для блоков. Вы также можете использовать символ табуляции или несколько пробелов;
пробелы: этот раздел позволяет настроить пробелы до и после управляющих структур и операторов практически для всех возможных вариантов. Например, установить пробел перед открывающей фигурной скобкой {, после запятых в определениях / вызовах методов, операции присваивания = и другие;
обтекание и фигурные скобки: аналогично предыдущему, но в этом случае обтекание строк для фигурных скобок управляющих структур и вызовов методов;
Empty rows: здесь можем настроить количество пустых строк между различными «разделами» кода как для минимальных незаполненных, которые нужно применить, так и для максимальных rows, которые нужно сохранить. Можем, например, настроить количество строк до и после импорта, строки между каждым объявлением метода и после заголовка класса;
JavaDoc: используется в программировании для генерации параметров из комментариев Java-кода;
расположение. Здесь есть два разных раздела:
правила группировки: как составлять группы. Можно настроить объединение методов получения и установки, переопределенных и зависимых;
правила соответствия: для упорядочения полей и методов, в зависимости от их модификаторов.
По какой-то причине можем захотеть хранить фрагменты в стороне от форматера IntelliJ IDEA. IDEA позволяет игнорировать их, используя маркеры форматирования.
Чтобы их использовать, сначала необходимо включить их в разделе «Файл/Настройки/Редактор/Стиль кода» в разделе «Управление форматером». Там следует выбрать маркеры. По умолчанию, это @formatter:on и @formatter:off. Их вы и будете применять.
При форматировании используются также горячие клавиши. Это наиболее эффективный способ управления, ведь он оптимизирует работу программиста, экономя его время и внимание. Но эта тема достойна того, чтобы о ней написали отдельную статью. Так и поступим! А пока у нас все.