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

Курсы

Программирование
Python Developer. Professional
-3%
Разработчик на Spring Framework
-5%
iOS Developer. Professional
-8%
Golang Developer. Professional
-6%
Базы данных
-12%
Agile Project Manager
-5%
Android Developer. Professional
-11%
Microservice Architecture
-5%
C++ Developer. Professional
-5%
Highload Architect
-6%
JavaScript Developer. Basic
-8%
Backend-разработчик на PHP
-9%
Архитектура и шаблоны проектирования C# Developer. Professional
-9%
Team Lead
-6%
Kotlin Backend Developer
-9%
Разработчик программных роботов (RPA) на базе UiPath и PIX Unity Game Developer. Basic Разработчик голосовых ассистентов и чат-ботов Node.js Developer Интенсив «Оптимизация в Java» Супер - интенсив по паттернам проектирования Супер - интенсив по Kubernetes iOS Developer. Basic Супер-интенсив «СУБД в высоконагруженных системах» Супер-интенсив "Tarantool"
Инфраструктура
DevOps практики и инструменты
-12%
Базы данных
-12%
Network engineer. Basic
-10%
Network engineer
-4%
Инфраструктурная платформа на основе Kubernetes
-6%
Экспресс-курс по управлению миграциями (DBVC)
-10%
Мониторинг и логирование: Zabbix, Prometheus, ELK
-10%
Administrator Linux. Professional
-6%
Разработчик IoT
-13%
Основы Windows Server Cloud Solution Architecture Разработчик голосовых ассистентов и чат-ботов VOIP инженер Супер-практикум по работе с протоколом BGP NoSQL Супер-практикум по использованию и настройке GIT Супер-интенсив «СУБД в высоконагруженных системах» Экспресс-курс «IaC Ansible»
Специализации Курсы в разработке Подготовительные курсы
+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 комментариев
Для комментирования необходимо авторизоваться