Стандарт оформления кода | OTUS
⚡ Подписка на курсы OTUS!
Интенсивная прокачка навыков для IT-специалистов!
Подробнее

Курсы

Программирование
iOS Developer. Professional Kotlin Backend Developer Flutter Mobile Developer Symfony Framework C++ Developer. Basic Unity Game Developer. Basic Java Developer. Professional
-35%
Highload Architect Unity Game Developer. Professional React.js Developer Специализация Java-разработчик
-25%
Алгоритмы и структуры данных
-16%
Scala-разработчик C# Developer. Professional
-23%
Разработчик голосовых ассистентов и чат-ботов Team Lead Архитектура и шаблоны проектирования NoSQL Web-разработчик на Python Golang Developer. Professional PostgreSQL Vue.js разработчик Супер-практикум по использованию и настройке GIT Разработчик IoT Подготовка к сертификации Oracle Java Programmer (OCAJP) Программист С HTML/CSS
Инфраструктура
Инфраструктурная платформа на основе Kubernetes Microservice Architecture Базы данных Highload Architect Reverse-Engineering. Professional
-8%
Network engineer. Basic Administrator Linux.Basic MongoDB Infrastructure as a code MS SQL Server Developer Cloud Solution Architecture Мониторинг и логирование: Zabbix, Prometheus, ELK Супер-практикум по использованию и настройке GIT Разработчик IoT Экcпресс-курс «ELK» Супер-интенсив "Tarantool" Экспресс-курс «CI/CD или Непрерывная поставка с Docker и Kubernetes» Экспресс-курс «Введение в непрерывную поставку на базе Docker»
Корпоративные курсы
Безопасность веб-приложений Экосистема Hadoop, Spark, Hive Пентест. Практика тестирования на проникновение Node.js Developer Java QA Engineer. Basic
-18%
Reverse-Engineering. Professional
-8%
DevOps практики и инструменты NoSQL Reverse-Engineering. Basic Cloud Solution Architecture Внедрение и работа в DevSecOps Супер-практикум по работе с протоколом BGP Game QA Engineer Супер - интенсив по Kubernetes Дизайн сетей ЦОД Экспресс-курс «IaC Ansible» Экспресс-курс по управлению миграциями (DBVC) Экспресс-курс "Версионирование и командная работа с помощью Git" Основы Windows Server
Специализации Курсы в разработке Подготовительные курсы Подписка
+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 комментариев
Для комментирования необходимо авторизоваться