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

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

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

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

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

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

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

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