Комментарии следует использовать даже в относительно простых и незамысловатых сценариях. В РНР существуют два формата комментариев: Однострочные комментарии обычно используются для коротких пояснений или примечаний, относящихся к локальному коду. Многострочные комментарии обычно используются при оформлении алгоритмов на псевдокоде и в более подробных объяснениях.
Оба способа в конечном счете приводят к одинаковому результату и совершенно не влияют на общее быстродействие сценария. Выбор варианта остается за вами. Однострочные комментарии
При оформлении однострочных комментариев используется два стиля комментирования. Оба стиля работают абсолютно одинаково, но в них используются разные служебные символы. В одном случае комментарий начинается с двойного символа «косая черта»(//), а в другом — с символа фунта(#). Ниже приведены примеры обоих стилей:
<? // Выбрать цвет роз $rose_color = "red";
# Выбрать цвет фиалок $violet_color = "blue";
print "Roses are $rose_color, violets are $violet_color" ?>
Конечно, оба стиля однострочных комментариев могут применяться для построения искусственных многострочных комментариев, как показано в следующем листинге:
<? // файл: example.php // автор: У.Дж.Гилмор // дата: 24 августа 2000 г.
print "An example with comments"; ?>
Многострочные комментарии
В РНР существует возможность построения подробных комментариев, занимающих несколько строк. Такие комментарии оформляются в стиле языка С — их начало и конец обозначаются символами /* и */.
<? /* Сценарий: multi_coramment_example.php Назначение : пример использования многострочных комментариев Автор: У.Дж.Гилмор Дата: 14 июня 2000 г. */
print "A multiline comment can be found at the top of this script!"; ?>
Как видите, многострочные комментарии особенно удобны для вывода относительно длинной сводной информации обо всем сценарии или его части.
