Добавление комментариев и разделение инструкций в PHP

Наличие грамотных комментариев оказывает незаурядное влияние на удобство поддержки кода в будущем и на общую его читабельность.

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

Как добавляются комментарии в PHP?

На наш выбор предоставляется несколько способов превращения кода в комментарии:

Однострочные в стиле C++

<?php
   echo "Привет, я сложный скрипт"; // наши заметки
?>

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

Однострочные в стиле Perl

<?php
   echo " Привет, я сложный скрипт"; # наши заметки
?>

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

Многострочные в стиле C

<?php
   echo " Привет, я сложный скрипт";
   /* Длинный и замысловатый коммент
   рассказывающий что и откуда мы взяли
   в этом фрагменте скрипта, а главное
   поясняющий зачем это было сделано */
?>

Как не сложно догадаться, начинается он с "/*", а заканчивается "*/". Все, что содержится внутри этих символов считается комментарием.

Обратите внимание!

Комментарием в этом случае будет считаться все до первой комбинации символов "*/". Не существует вложенных комментариев из разряда:

яндекс директ контекстная реклама сайта.

<?php
 /*
    echo " Привет, я сложный скрипт"; /* А я ошибка в коде */
 */
?>

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

Частные случаи комментирования

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

<p>Текст 1 <?php # echo "Проверка связи";?> Текст 2</p>

Да, на экране мы получим «Текст 1 Текст 2», поскольку с окончанием блока PHP заканчивается и шедший в нем комментарий.

Исключение составляет только </script>, который не закончит комментарий, а попадет в него.

Разделение инструкций в PHP

Парсеру о окончании инструкции сообщает символ «;».

<?php
   echo 'Первая инструкция';
   echo 'Вторая инструкция';
?>

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

<?php
   echo 'Первая инструкция';
?>
<?php echo 'Первая инструкция'; ?>

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