Использование комментариев

Существует два способа добавления комментариев к коду РНР. Первый способ, предусматривающий размещение в начале строки двух прямых слешей, превращает в комментарий отдельную строку:

// Это комментарий

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

// echo "X equals $х":

Такой комментарий можно также вставить сразу же после строки кода, чтобы описать ее действие:

$х + = 10; // Увеличение значения $х на 10

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

Пример. Многострочный комментарий

 <?php
/* Это область
многострочного комментария,
которая не будет подвергаться интерпретации */
?>

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

Типичной ошибкой является использование пар символов /* и */ для того, чтобы закомментировать большой фрагмент кода, уже содержащий закомментированную область, в которой используются эти же пары символов.

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

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