PHP: Комментарии

Комментарий - это пояснение.

С точки зрения интерпретатора, комментарий - это текст, который игнорируется при интерпретации кода.

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

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

PHP поддерживает три вида комментариев: два однострочных и один многострочный. Всё, что идёт после символов // (два слэша) или # (решётка) и до конца строки, считается комментарием (однострочным). Всё, что находится между символами /* и */ также считается комментарием, такой вид комментария называется многострочным, так как он может состоять из нескольких строк, если символы /* и */ расположить на разных строках:

// Однострочный комментарий
# Другой однострочный комментарий

/* Это многострочный комментарий */

/*
* Это ещё один многострочный комментарий.
* Он расположен на нескольких строках
* и может содержать различные символы.
* Звёздочки слева вставлены для красоты.
*/

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

/*
    echo "Это тест"; /* Этот комментарий создаст проблему */
*/

С этой темой смотрят: