Стиль кодирования

Представьте ситуацию, что вам пришлось разбираться в собственном коде 2х летней давности. Или представьте, что вы работаете в команде с несколькими людьми, которые привыкли писать код по разному. Да и просто посмотрите на кусок кода ниже. Можно ли сходу понять какая именно логика тут выполняется?

Или вот тот же кусок кода, только в другом стиле кодирования (сложно даже это стилем назвать…)

Без подробных разбирательств что к чему, ни один разработчик не сможет рассказать что именно написано здесь.

Если же мы увидим правильно отформатированный код, то сразу же сможем понять какая логика скрыта в том или ином куске кода.
Тот же самый код, но с правильным форматированием

Зачем это нужно, скажете вы, ведь я этот код написал, и я прекрасно знаю что именно он делает. Да, знаете. Пока. А через год для вас данный кусок кода превратится в мешанину из символов. Или если вы работаете вместе с коллегами, и используете разные стили кодирования, то совместная работа может превратиться в ад.

Именно поэтому и были разработаны единые стандарты кодирования – PSR-2 (перевод стандарта)

Настоятельно рекомендую с ним ознакомиться, и прививать себе привычку использовать его прямо сейчас. А phpstorm вам в этом деле с радостью поможет.

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

  • В файлах НЕОБХОДИМО использовать только теги <?php и <?=.
  • Файлы НЕОБХОДИМО представлять только в кодировке UTF-8 без BOM-байта.
  • Имена функций ДОЛЖНЫ быть объявлены с использованием т.н. «camelCase» (первое слово пишется в нижнем регистре, далее каждое слово начинается с большой буквы, а между словами нет разделителей).

 

Данный пункт не выходит в PSR, но мне было бы намного удобнее проверять ваши работы 🙂

  • Имена переменных ДОЛЖНЫ быть объявлены с использованием т.н. «camelCase» (первое слово пишется в нижнем регистре, далее каждое слово начинается с большой буквы, а между словами нет разделителей).

 

На самом деле их намного больше. Они регулируют даже такие вещи как пробелы между условиями if и открывающейся скобкой { и многое другое. Но эти моменты самые важные.

← Вернуться к списку статей