Во время написания скриптов на PHP периодически требуется для целей отладки или для указания комментария, отмечать некоторые строки как комментарии. В языке программирования PHP имеется 2 вида таких комментариев:
- Однострочный комментарий
- Многострочный комментарий
Однострочный комментарий в PHP.
Однострочный комментарий в PHP применяется:
- для быстрого заккомментирования одной-двух строчек кода;
- а также применяется для того, чтобы оставить небольшой комментарий к коду
<?php
// Выводим дату
echo 'Сегодня дата ' . date('Y-m-d'); // в формате Год-Месяц-День
// Подумать, может выводить и время тоже
// echo 'Сегодня дата ' . date('Y-m-d H:i:s');
Однострочный комментарий в PHP это два символа слеша // . В примере кода выше имеется 4 таких комментария.
Любой текст, код который находится за последовательностью символов // будет проигнорировано интерпретатором PHP и не будет обрабатываться.
В результате работы кода выше будет выведена, например такая строка:
Сегодня дата 2019-03-25
Многострочный комментарий
В случае, когда комментарием одной строкой не обойтись, то следует использовать многострочный комментарий. Его синтаксис следующий:
/* .....
....
...
.... */
Любой текст или код, который будет заключен, между симовалами /* и */ воспринимается как комментарий и не будет обработан.
Гораздо чаще многострочный комментарий будет выглядеть, как:
/*
* Здесь некоторый текст
* Еще немного текста
* ......
*/
Также многострочный комментарий может быть записан в одну строку:
/* здесь некоторый комментарий */
Наиболее часто в профессиональной разработке на PHP вы будете встречать и использовать сами, многострочные комментарии в стиле PHPDoc (для чего такие комментарии используются, подробнее будет в отдельной статье):
<?php
/**
* @param array $numbers
* @return float|int
*/
function getSum(array $numbers) {
return array_sum($numbers);
} Как можете обратить внимание, что в примере кода выше, такой специальный многострочный комментарий описывает тип входных аргументов (array), и тип возвращаемого значения (float или int) для функции getSum().
Будут ли видны Ваши комментарии в браузере?
Написанный вами PHP код выполняется только на сервере, и результат работы любого скрипта PHP этот текст, который уже отдается в браузер. В случае ВЕБ программирования результатом работы PHP скриптов, как правило является сгенерированыый HTML документ с тегами. И самое главное, что интерпретатор php, выполняя скрипт, игнорирует все строки заключенные в символы комментариев.
А значит ни одна строчка или строчки вашего кода, отмеченные как комментарии, никогда не будут обработаны, а их содержимое никогда не будет доступно в браузере у конечного пользователя.
Резюмируем.
При написании кода на языке программирования PHP принято использовать однострочные комментарии (//………) и многострочные комментарии (/* ………………… */).