Стандарти кодування e+CMS
- Отступы
- Управляючі структури
- Виклик функції
- Определения функций
- Комментарии
- Подключение кода (including)
- Тэги PHP-кода
- Блок комментариев в заголовке
- Использование CVS
- Примеры URLов
- Соглашения об именах
- File Formats
- E_STRICT-compatible code
- Error Handling Guidelines
- Best practicesv
- Sample File (including Docblock Comment standards)
- The PEAR toolbox
Стандарти кодування e+CMS використовуються в коді, котрий в результаті вважається частиною e+CMS і є доступна для скачивания.
Відступи
Використовуйте табуляцію, а не пробіли. Для візуалізіцію табулятора використовуйте 4 пробіла. Це можна налаштувати в любому редакторі.
Управляючі структури
Управляющие структуры включают в себя операторы if, for, while, switch, и др. Ниже приведен пример оформления оператора if, который в этом отношении является самым сложным:
<?php
if ((condition1) || (condition2)) {
action1;
} elseif ((condition3) && (condition4)) {
action2;
} else {
defaultaction;
}
?>
В управляющих структурах между ключевым словом и открывающей круглой скобкой должен находиться пробел, чтобы отличать их от вызова функций.
Настойчиво рекомендуется использовать фигурные скобки, даже в том случае, когда их использование не является необходимостью. Использование фигурных скобок увеличивает читабельность кода и уменьшает вероятность логических ошибок при изменении кода.
Cинтаксис оператора switch:
<?php
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
?>
Виклик функції
Вызовы функций должны быть написаны без отступов между именем функции, открывающей скобкой и первым параметром. Отступы в виде пробела должны присутствовать после каждой запятой в перечислении параметров. Пробелов также не должно быть между последним параметром, закрывающей скобкой и точкой с запятой. Пример:
<?php
$var = foo($bar, $baz, $quux);
?>
Как можно заметить, в примере используются пробелы с двух сторон от знака "=". Если подобные присвоения результатов функций переменным объединяются в блоки, то для повышения читабельности рекомендуется следующий синтаксис:
<?php
$short = foo($bar);
$long_variable = foo($baz);
?>