3.4: Комментарии в PHP коде
Главная Страница » Книги по PHP » Самоучитель PHP 5 для чайников с примерами » Комментарии в языке (коде) PHP
Часто нужно внести разные пояснения в код программы, или сделать какие нибуть небольшие пометки. Для этого и применяют разные комментарии. Это специальная конструкции языка, которые позволяют выделять ту часть кода, которую игнорируют при выполнении программы. Комментарии в языке РНР бывают многострочные и однострочные.
С помощью комментариев однострочных можно закомментировать все до самого конца строки или до закрывающего тега (?>). Посмотрим как пример листинг 3.6.
Листинг 3.6. Примеры комментариев в программе.
‹?php
//echo "Это однострочный комментарий РНР в стиле С++";
#echo "Это однострочный комментарий РНР в стиле Unix";
?>
// Эта строчка не является комментарием РНР
‹!- Эта строчка является комментарием HTML -›
Но обратите внимание на то, что при попытке комментировать строчку вне тегов ‹?php ... ?› у нас ничего не получается. А проблема в том, что // и # - это конструкция языка РНР. Вне тегов они будут приняты как самый обычный текст. В данном случае можно использовать комментарии HTML.
Когда Вы используете многострочные комментарии (/* ... */) на то что будет написано внутри этой конструкции, программа не обратит внимания. Для примера посмотрим на листинг.
Листинг 3.7. Ошибка при использования многострочных комментариев.
‹?php
/*Текст внутри
этих конструкций
игнорируется*/
/* echo "Будет ошибка!!!"; /*Так нельзя*/ */
?›
Обратим внимание, что при использовании многострочных комментариев. В предоставленном примере будет ошибка! После обнаружения открывающей части конструкции (/*), будут искать любую закрывающую (*/). В конечном итоге без комментария остается тот знак */, который вызывает ошибку.
В основном из комментариев применяют для отладки и также тестирования программы, и еще для пояснения кода. Нужно сказать, что программисты, которые только начинают, не очень любят их использовать. Это нормально, потому что задачи, предстоящие перед ними, обычно тривиальны и их не нужно объяснять. Но тем не менее, когда программа достигла величайших размеров, применение комментариев обязательно.