PHP - стандарт кодирования

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

Вот несколько причин, почему использовать спецификации кодирования:

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

Есть несколько рекомендаций, которым можно следовать при кодировании на PHP.

Indenting and Line Length- Используйте отступ в 4 пробела и не используйте табуляцию, потому что разные компьютеры используют разные настройки для табуляции. Рекомендуется, чтобы длина строк составляла примерно 75-85 символов для лучшей читаемости кода.
Control Structures- Сюда входят if, for, while, switch и т. Д. Управляющие операторы должны иметь один пробел между ключевым словом control и открывающей скобкой, чтобы отличать их от вызовов функций. Мы настоятельно рекомендуем всегда использовать фигурные скобки даже в тех случаях, когда это технически необязательно.

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

Вы можете написать операторы переключения следующим образом -

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

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

$var = foo($bar, $baz, $quux);

Function Definitions - Объявления функций соответствуют "стилю BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

Comments- Комментарии в стиле C (/ * * /) и стандартные комментарии C ++ (//) подходят. Использование комментариев в стиле Perl / shell (#) не рекомендуется.
PHP Code Tags- Всегда используйте <? Php?> Для разделения кода PHP, а не <? ?> стенография. Это требуется для совместимости с PHP, а также является наиболее переносимым способом включения кода PHP в разные операционные системы и настройки.
Variable Names -
- Используйте все строчные буквы
- Используйте "_" в качестве разделителя слов.
- Глобальные переменные должны быть предварены буквой «g».
- Глобальные константы должны быть заглавными с разделителями "_".
- Статические переменные могут быть добавлены с помощью 's'.
Make Functions Reentrant - Функции не должны хранить статические переменные, которые препятствуют повторному входу функции.
Alignment of Declaration Blocks - Блок объявлений должен быть выровнен.
One Statement Per Line - Должен быть только один оператор в строке, если только утверждения не очень тесно связаны.
Short Methods or Functions - Методы должны ограничиваться одной страницей кода.

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