Правила "хорошего тона" программирования при создании сайтов.
Все мы знаем правила "хорошего тона" в обычной жизни, есть они и в программировании.
Чтобы понять, зачем нужен этот урок, рассмотрим два небольших фрагмента кода
(листинги 1.1 и 1.2).
Листинг 1.1
if ($page==="show")Стиль кодированияСтиль кодирования
{
if ($f ile==="") {$txt="<pxfont class=textxb>404: запрашиваемый вами файл не найден</а>";}
elseif {!is_readable($file.".html")) {$txt="<pxfont class = textxb>404:
запрашиваемый вами файл не найден</а>";} else {
$txt=join('',file($file.".html"));}}
Листинг 1.2
if ($page==="show")
{
// Параметр $file не передан
if ($file==="")
$tXt=$ERROR404;
// Файл не существует
elseif (!is_readable($file.".html"))
$txt=$ERROR404;
II Файл существует, выводим его else
$txt=join('',file($file.".html"));
}
Давайте посмотрим внимательно на эти листинги и попытаемся разобраться, чем же они различаются.
Вы уже догадались, что первый фрагмент— это пример неправильно написанного кода,
а второй — пример того, как нужно писать код.
Перечислим отличия второго фрагмента от первого.
1. Четко выделены блоки — понятно, где начинается и где заканчивается тот или иной блок и какие действия в нем выполняются.
2. Удалены ненужные фигурные скобки — поскольку в блоке только один оператор, то обрамлять его фигурными скобками не нужно,
это улучшит читабельность и облегчит поиск ошибки, если вы где-то забудете закрыть блок. .
3. Код снабжен комментариями — даже если вы пишете код только для себя, старайтесь прокомментировать его,
конечно, не так подробно, как показано в примере. Комментарии вам пригодятся не сразу, а месяца через два-три,
когда понадобится что-то изменить в коде — вот тогда вы сразу поймете, что есть что, и вам не придется читать сам код,
чтобы выяснить, что он делает.
4. Строковые константы вынесены отдельно — они могут быть присвоены явно или прочитаны из файла
до выполнения данного фрагмента кода, в результате повышается удобство чтения кода.
5. Фигурные скобки первого блока расположены на одном уровне — это существенно облегчает поиск ошибок,
когда вы забудете (а это рано или поздно произойдет, если уже не произошло) "закрыть" блок.
Компилятору-то все равно, а вот вам будет проще.
Второй фрагмент обладает большей "читабельностью", чем первый, а это облегчает жизнь и вам, и тому программисту, который,
возможно, после вас будет дорабатывать ваш код. Да и смотреть на такой код приятнее, чем на первый листинг,
напоминающий просто набор операторов.
В этом уроке мы поговорим о том, как правильно писать код. Заранее отмечу, что существуют четыре основных стиля записи PHP-кода,
но здесь мы рассмотрим только два наиболее часто встречающихся. Все равно все четыре способа вы сразу не запомните:
они только "перемешаются" в вашей голове, и у каждого читателя "родится" пятый, собственный способ.