Чемодан для гидов по стилю

Табуляция или пробелы? Одиночные или двойные кавычки? Как разработчик, ваше время более разумно тратить на изучение и понимание того, что делает код, а не на попытки выяснить особенности того, как предыдущий инженер (или вы, шесть с лишним месяцев назад) любил стилизовать вещи. Enter: руководство по стилю.

Руководство по стилю - это набор соглашений и передовых методов написания кода. Следование руководству по стилю не только поможет вам писать чистый, последовательный и легкий для чтения код, но и соблюдение единообразия облегчит обнаружение ошибок, внесение изменений в код в будущем и позволит командам лучше выполнять анализ кода.

На многих языках есть официальное руководство по стилю, такое как Golang’s Effective Go, а для большинства других есть широко распространенное руководство по стилю, которое вы и ваша команда разработчиков можете реализовать. Где я работаю, мы следуем руководству по стилю Google для наших проектов Java, которое опубликовано в репозитории руководств по стилям Google.

Ссылка: Руководство по стилю Google для Java

Автоматизация вашего стиля

Вы можете продвинуться дальше в реализации руководства по стилю и автоматизировать проверки в своей среде IDE. Вы получите преимущество, которое упростит соблюдение принятого вашей командой руководства по стилю за счет автоматического выделения отклонений от руководства при написании кода. Большинство IDE поддерживают применение руководства по стилю с автоматическими проверками и функциями рефакторинга. Здесь мы рассмотрим, как настроить JetBrains IntelliJ для Google Style Guide for Java.

Загрузите файл intellij-java-google-style.xml из репозитория google / styleguide здесь.

  • Запустите IntelliJ, перейдите в меню Настройки ›Настройки… и разверните подменю Стиль кода под Редактором. Здесь вы увидите список поддерживаемых языков. Выберите Java.

IntelliJ позволяет настраивать схемы стилей кода как на глобальном (IDE), так и на уровне проекта. Вы можете выбрать, хотите ли вы импортировать руководство на уровень Project или IDE, выбрав схему по умолчанию в раскрывающемся меню Схема (выделено жирным шрифтом). Настройка схемы руководства по стилю на уровне IDE позволит вам использовать руководство по стилю для всех новых проектов, что упростит реализацию руководства по стилю вашей команды в будущем.

  • Рядом с раскрывающимся меню Схема выберите значок шестеренки, затем выберите Схема импорта ›XML-код стиля кода IntelliJ IDEA, затем выберите загруженный файл intellij-java-google-style.xml. из GitHub. Дайте схеме имя (или используйте имя GoogleStyle по умолчанию из импорта). Нажмите ОК или Применить, чтобы настройки вступили в силу. Примечание. У вас есть возможность просмотреть и изменить любое из соглашений руководства по стилю, если вы или ваша команда решите это сделать.

Применение руководства по стилю Google в вашем Java-коде

Теперь, когда вы импортировали руководство по стилю в IntelliJ, вы можете воспользоваться меню функций кода и применить руководство по стилю к своему коду. У вас есть возможность переформатировать весь пакет / папку, выбрав пакет в меню навигации, в текущем открытом файле .java или выбрав код из текущего открытого файла, выделив код, который вы хотите переформатировать. Выберите Код ›Переформатировать код.

Ваш код будет автоматически переформатирован в соответствии с Руководством по стилю Google для Java.

Совет по рабочему процессу: возьмите за привычку переформатировать код перед каждой фиксацией.

Заключение

Руководство по стилю - это набор стандартов, которые группы разработчиков могут реализовать для обеспечения единообразия в проектах форматирования и организации кода. Многие языки поддерживают официальные руководства, в то время как большинство других имеют широко признанные стандарты, такие как Руководство по стилю Google для Java. Используя функцию стиля кода IntelliJ, вы можете импортировать и автоматически применять Google Java Style Guide при написании кода. Если ваша IDE работает на вас, вы сможете больше думать о решении проблем и отладке вместо того, чтобы беспокоиться о форматировании.