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

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

В PHP есть два вида комментариев:

• Однострочные;
• Многострочные.

Пример записи однострочного комментария:

// это однострочный комментарий 

Пример записи многострочного комментария:

/*
 Код помещенный здесь не выполняется
 echo 55; 
 еще строчка 
 еще строчка 
*/

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

    /**
     *
     * Подключаем файл с базовыми функциями,
     * которые описаны для всех списков
     *
     */

require_once __DIR__ . '/basicdata.php';

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

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