Стандарт оформления кода | OTUS
⚡ Открываем подписку на курсы!
Проходите параллельно 3 онлайн-курса в месяц по цене одного.
Подробнее

Курсы

Программирование
Программист 1С Реверс-инжиниринг. Продвинутый курс
-16%
Java Developer. Professional
-17%
JavaScript Developer. Professional
-18%
Flutter Mobile Developer
-15%
JavaScript Developer. Basic
-16%
Highload Architect
-10%
Нереляционные базы данных
-17%
Подготовка к сертификации Oracle Java Programmer (OCAJP)
-8%
Алгоритмы и структуры данных
-12%
Архитектура и шаблоны проектирования
-14%
Framework Laravel
-13%
IoT-разработчик
-12%
Team Lead
-15%
VOIP инженер Разработчик C# Разработчик на Spring Framework AWS для разработчиков Cloud Solution Architecture CI/CD Vue.js разработчик Разработчик Node.js Scala-разработчик Супер - интенсив по Kubernetes Symfony Framework Advanced Fullstack JavaScript developer
Специализации Курсы в разработке Подготовительные курсы
+7 499 938-92-02

Стандарт оформления кода

PHP_Deep_Last_23.07_2_site.png

В любой сфере или области существуют определённые стандарты. Стандарты конструкций, размеров, технических процессов. Например, в России и большинстве стран СНГ при строительстве железной дороги используют установленный стандарт ширины колеи – 1520 мм. А теперь представьте, что было бы, если каждая строительная бригада использовала бы свой стандарт. На таких рельсах далеко бы мы не уехали…

В оформлении кода тоже существуют стандарты. Их несколько, но все они так или иначе описывают примерно следующее:

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

Есть общепринятые стандарты, такие как PSR, а есть и стандарты, установленные внутри команды. Так или иначе, стандарты упрощают жизнь программисту. Например, в стандарте PSR-4 есть правило – называть файл в соответствии с кратким именем класса и класть его в папки, имена которых совпадают с неймспейсами. Оно явно упрощает поиск и структуру файлов.

Например, класс admin\lib\Action будет находиться по пути admin/lib/Action.php. Останется лишь добавить к этому автозагручик, используя spl_autoload_register и можно будет вызывать класс без предварительного его подключения (require).

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

Есть вопрос? Напишите в комментариях!

Не пропустите новые полезные статьи!

Спасибо за подписку!

Мы отправили вам письмо для подтверждения вашего email.
С уважением, OTUS!

Автор
0 комментариев
Для комментирования необходимо авторизоваться