Форматирование исходного кода в CodeLobster PHP IDE

Программисты постоянно публикуют образцы своих работ в блогах и на форумах, обмениваются сниппетами кода даже в мессенджерах и по электронной почте.

Встроенная в IDE возможность авто-форматирования значительно облегчит чтение, понимание и повторное использование участков кода, взятых из различных источников.

В CodeLobster PHP IDE для таких целей есть специальный инструмент — Code Formatter, он доступен из главного меню «Tools» -> «Code formatter».

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

Во время редактирования достаточно выполнить команду «Format» или нажать горячие клавиши Alt + Shift + F, чтобы устранить дефекты форматирования и сделать код аккуратным и читаемым.

В новой версии IDE этот инструмент получил дополнительные функции и множество полезных настроек. Теперь у программистов есть возможность быстрее разбираться с исходниками и легче взаимодействовать в команде.

Стиль кодирования — его важность и значение

Придерживаться определённых правил при оформлении своих программ нужно всегда, даже если вы работаете над собственными проектами в одиночку.

Находясь в коллективе, где идёт настоящая работа с фреймворками, готовыми Open source проектами, бакендами для WEB и так далее, вы будете вынуждены производить код именно в таком виде, в каком его ожидают получить ваши коллеги.

В идеальных условиях весь исходный код проекта, над которым работают участники команды, должен выглядеть так, как будто он написан одним единственным программистом.

Необходимость работать с исходными файлами, оформленными в различных стилях форматирования, может утомлять и отвлекать разработчика. Вот почему так важно придерживаться общих правил при командной работе.

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

Единый стиль оформления кода в компании

Для крупной компании разработка единого стиля оформления программного кода является обязательной для повышения производительности и снижения стоимости поддержки уже работающего ПО.

Легко читаемый, хорошо структурированный и документированный код напрямую влияет на дальнейшую работу по улучшению и расширению функциональности, упрощает работу в команде и тестирование кода.

Вопрос читаемости становится особенно важным в том случае, когда в компании производится процесс рецензирования (Code review) или если вашим продуктом является собственно исходный код, разработанный для клиента.

Процесс форматирования можно отнести к микро-рефакторингу, он не изменяет архитектуру самого приложения и не влияет на логику работы программы. Заниматься этим нужно постоянно, стараясь исправить все несоответствия стандарту ещё до того, как код попадёт в очередной коммит.

Главное, чтобы некачественный или некорректно отформатированный код в результате не вошёл в состав вашего программного продукта.

Форматирование PHP и JavaScript

Существует два различных стиля по оформлению основных блочных элементов кода, таких как определение функций и классов, проверка условий и выполнение циклов.

Эти два подхода в корне различаются манерой размещения фигурных скобок и способом распределения вертикального пространства на экране:

• Allman (BSD стиль) — скобка всегда следует за открывающим выражением на новой строке. Позволяет лучше выделить начало и конец блока, а так же идеально акцентирует внимание на содержимом блока. Исключается возможность случайной потери парной скобки при комментировании одной отдельной строки, например, если вы решили заменить цикл FOR на FOREACH;
• Современная вариация Kernighan and Ritchie (K&R стиль) — скобка во всех случаях располагается на одной строке с открывающим выражением. Наиболее компактный стиль, максимально экономит вертикальное экранное пространство. Позволяет увеличить количество визуально воспринимаемой информации и избавляет от лишней необходимости прокрутки окна редактора.

Чтобы управлять процессом автоматического форматирования в CodeLobster IDE, откройте  настройки инструмента Code Formatter, перейдите в главное меню «Tools» -> «Code formatter» -> «Settings».

IDE предлагает возможность выбрать уже готовый стиль из списка. Каждый вариант основан на одном из самых распространённых стандартов используемых профессионалами по всему миру:

• Allman — широко известный и популярный стиль, внедрён программистом Эриком Олманом из Университета Беркли;
• Drupal — стандарт, который используются при разработке ядра и модулей CMS Drupal. Данные соглашения базируются на стандартах кодирования PEAR;
• PEAR — поддерживается сообществом разработчиков повторно используемых компонентов PHP, этот стиль кодирования хорошо знают все PHP программисты;
• Symfony2 — разработчики данного фреймворка также следуют набору соглашений по стилю кодирования. В этом случае преимущественно используются рекомендации из стандарта PSR;
• PSR2 — стиль из набора рекомендаций по всем основным аспектам оформления проектов и организации кода при программировании на PHP;
• Zend — стандарт для всех, кто работает с Zend Framework. Документация содержит правила по форматированию PHP файлов, соглашения по именованию и стилю кодирования.

Можно выбрать различный формат для JavaScript или PHP, внести изменения и сразу же просмотреть результат в нижней части диалогового окна.

Здесь внимание уделено настройке положения фигурных скобок в различных контекстах, размещению таких выражений как IF, ELSEIF и CATCH. Также настраивается установка пробелов перед проверкой условий.

Эти настройки будут автоматически применяться к содержимому исходных файлов когда вы копируете и вставляете код в редакторе или выполняете команду «Format».

Вы можете взять за основу любой из предопределённых стандартов, изменить его и сохранить под собственным именем. Это самый быстрый способ создать стиль с учётом личных требований и предпочтений, а затем использовать его глобально для всей компании или применительно к отдельным проектам.

Форматирование HTML и CSS

Несмотря на относительную простоту языков HTML и CSS, поддержка больших объёмов кода является трудной задачей. В данном случае правильная организация файлов проекта и документирование выходят на первый план.

Единственный способ облегчить дальнейшую работу с кодовой базой HTML и CSS — это с самого начала работы установить стандарты кодирования и строго придерживаться их.

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

Так же включите нужные опции для настройки выравнивания отдельных свойств и решите, допускать их расположение на одной и той же строке или нет.

Перейдём к настройке авто-форматирования для HTML. У вас есть возможность определить, как будут располагаться открывающий и закрывающий теги в разметке и следует ли делать перенос строки сразу же после открывающего тега.

Даже код идеально свёрстанного HTML шаблона может быть практически не читаемым и дизайнеру потребуется дополнительное время для его анализа.

Настройка стиля в совокупности с автозавершением и подсветкой закрывающих тегов ускорят процесс вёрстки, помогут использовать правильные отступы для вложенных тегов и соблюдать видимую симметрию.

Подведём итог

Стандарты, описанные в статье, являются рекомендациями, а не законами. Тем не менее, эти документы следует тщательно изучить. Они разработаны сообществом опытных программистов и полностью основаны на практических результатах.

CodeLobster IDE обеспечивает удобный способ настройки собственного оформления программ и помогает выпускать легко читаемый, структурированный и синтаксически корректный код.

Современная среда программирования в первую очередь должна повышать общую эффективность процесса кодирования, при этом вы будете экономить ресурсы, уходящие на поддержку и тестирование ПО.

В конце-концов, компьютеры понимают любой код, но если вы заботитесь о том, чтобы ваш программный продукт функционировал и развивался на протяжении многих лет, то лучше установить чёткие правила по стилю, как для себя лично, так и для всех разработчиков в своей компании, главное — всегда строго следовать этим правилам.