3.5: Оформление PHP кода программы
Главная Страница » Книги по PHP » Самоучитель PHP 5 для чайников с примерами » Стандарты оформления PHP кода
Самое главное, что нужно от программы, - это правильное выполнение предоставленной задачи. В большинстве случает оформление кода никому не интересно, кроме вас самих. Но представьте себе, что условия задачи изменились, и вам нужно исправить программу. И конечно же, если вы делаете чей-то заказ, то от вас потребуют вложиться в кратчайшие строки. Пример посмотрим на листинге 3.8.
Листинг 3.8. Плохое оформление PHP кода программы.
‹? php
$i=1;$j=2;if($i›1Mif(Sj‹l){echo"A"; }else{echo“B”;}}else{echo"C";}
?›
Предоставленный фрагмент программы работает нормально. Я понял местами всего два символа в этой строчке, после изменений при запуске программы возникала ошибка, и тогда я попросил у своего друга программиста, чтобы он ее исправил. Процесс исправления у него занял около пяти минут. Ну, а представьте что таких строчек тысячи.
Хорошее оформление кода очень важно, если над программой работают, команда а не один человек. Качество и скорость создания проекта очень важно от взаимопонимания всех сотрудников команды.
Все это и много чего другого, заставило программистов держаться при каких-то стандартах в процессе оформления кода. Язык РНР не был исключен. Специально для него был создан РНР Coding Standard (автор Фредрик Кристиансен), на которого мы будем ссылаться в нашей книге. Но нужно запомнить, что это не требования, а просто рекомендации.
По окончанию этой главы, мы дадим вам несколько полезных советов, которые касаются использования комментариев для оформления программного кода:
(!) для коротких пояснений используйте однострочные комментарии (см. листинг 3.9)
Листинг 3.9. Использование однострочных комментариев.
‹?php
// если $ехрr отлично от нуля, то вывести сообщение
if ($ехрr)
{
echo "Hello, world!"; // вывод сообщения
}
?›
(!) для развернутых пояснений используйте многострочные комментарии (см. листинг 3.10)
Листинг 3.10. Использование многострочных комментариев.
‹?php
/*
****************************************
*
*
* В предоставленной части программы присутствует описание функций для работы с базами данных
*
*
****************************************
*/
?›
Для того чтобы комментировать большие блоки программ старайтесь не использовать многострочные комментарии, потому что может возникнуть ошибка, описание в этой главе присутствует. Один из самых простых способов это – использование конструкции (см. листинг 3.11)
Листинг 3.11. Комментирование огромных блоков программы.
‹/php
if (0)
{
// большой блок программы
}
?›
Старайтесь придумывать комментарии, которые понятны не только вам, но и другим людям.
