Возможно, знание о правильном прописывании комментариев в PHP-скриптах понадобятся не только мне, но и кому-либо ещё при изучении PHP. И так уж получилось (нелогично), что первым материалом нового раздела будет статья о правильном закомменчивании кода PHP в нужных местах.
Комментарии в PHP коде
Для чего они нужны?
- Для скрытия части ненужного кода, который может понадобится в дальнейшем.
- При обучении языку PHP важно на ранних этапах учёбы оставлять комментарии в коде, чтобы запомнить, что делает та или иная функция, запрос и т.п.
- Комментарии оставляют и гуру PHP для того, чтобы через полгода вдруг вернувшись в редактирование кода облегчить задачу себе (а, может, и коллеге «по цеху») работу с кодом и понять что там написано, тем самым экономя своё драгоценное время
Типы комментариев
Всего есть три типа комментариев:
- //
- /* */
- #
Ну и сразу чуть ниже выложу примеры комментарий в коде PHP. Они нехитрые и их нужно запомнить или хотя бы записать на листочке бумаги или в блокноте на компьютере, чтобы быстрее запомнить и пользоваться ими всегда.
Примеры комментариев в PHP:
А, собственно, и вот сами примеры:
Однострочные комментарии можно прописывать (точнее, они будут работать) лишь до конца строки или текущего блока кода. Если у вас очень большой код, и многие блоки нужно закомментировать — следите, чтобы не было вложенных комментариев в PHP-скриптах. Вложенные комментарии не будут работать в PHP-коде.
Быстрого вам обучения языку программирования PHP, прямых рук, грамотного и безопасного кода, прекрасных и интересных проектов! Удачи!