Учебники

PHP — Стандарт кодирования

Декабрь 3, 2018

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

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

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

  • Простота и ясность, достигнутая благодаря последовательному кодированию, избавляет вас от распространенных ошибок.

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

  • Его отраслевой стандарт соответствует определенному стандарту качества программного обеспечения.

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

Простота и ясность, достигнутая благодаря последовательному кодированию, избавляет вас от распространенных ошибок.

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

Его отраслевой стандарт соответствует определенному стандарту качества программного обеспечения.

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

  • Отступ и длина строки — используйте отступ из 4 пробелов и не используйте вкладки, потому что разные компьютеры используют разные настройки для вкладки. Рекомендуется, чтобы строки были длиной примерно 75-85 символов для лучшей читаемости кода.

  • Управляющие структуры — Они включают, если, в течение, switch, и т. Д. Операторы управления должны иметь один пробел между ключевым словом control и открывающей скобкой, чтобы отличать их от вызовов функций. Вам настоятельно рекомендуется всегда использовать фигурные скобки даже в тех случаях, когда они технически необязательны.

Отступ и длина строки — используйте отступ из 4 пробелов и не используйте вкладки, потому что разные компьютеры используют разные настройки для вкладки. Рекомендуется, чтобы строки были длиной примерно 75-85 символов для лучшей читаемости кода.

Управляющие структуры — Они включают, если, в течение, switch, и т. Д. Операторы управления должны иметь один пробел между ключевым словом control и открывающей скобкой, чтобы отличать их от вызовов функций. Вам настоятельно рекомендуется всегда использовать фигурные скобки даже в тех случаях, когда они технически необязательны.

Примеры 

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

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

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

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

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

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

  • Определения функций — Объявления функций следуют «стилю BSD / Allman» —

Определения функций — Объявления функций следуют «стилю BSD / Allman» — 

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

  • Комментарии — комментарии в стиле C (/ * * /) и стандартные комментарии C ++ (//) в порядке. Использование комментариев в стиле Perl / shell (#) не рекомендуется.

  • Теги кода PHP — всегда используйте <? Php?> Для разделения кода PHP, а не <? ?> стенография. Это требуется для соответствия PHP, а также является наиболее переносимым способом включения кода PHP в различные операционные системы и установки.

  • Имена переменных —

    • Используйте все строчные буквы
    • Используйте «_» в качестве разделителя слов.
    • Глобальные переменные должны начинаться с «g».
    • Глобальные константы должны быть заглавными буквами с разделителями ‘_’.
    • Статическим переменным может предшествовать ‘s’.

  • Сделать функции реентерабельными — функции не должны хранить статические переменные, которые препятствуют реинтеграции функции.

  • Выравнивание блоков декларации. Блок деклараций должен быть выровнен.

  • Один оператор на строку — в строке должен быть только один оператор, если только операторы не очень тесно связаны.

  • Короткие методы или функции — методы должны ограничивать себя одной страницей кода.

Комментарии — комментарии в стиле C (/ * * /) и стандартные комментарии C ++ (//) в порядке. Использование комментариев в стиле Perl / shell (#) не рекомендуется.

Теги кода PHP — всегда используйте <? Php?> Для разделения кода PHP, а не <? ?> стенография. Это требуется для соответствия PHP, а также является наиболее переносимым способом включения кода PHP в различные операционные системы и установки.

Имена переменных —

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

Выравнивание блоков декларации. Блок деклараций должен быть выровнен.

Один оператор на строку — в строке должен быть только один оператор, если только операторы не очень тесно связаны.

Короткие методы или функции — методы должны ограничивать себя одной страницей кода.

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

43
Share: