Коментарите в PHP е възможност ние да документираме кода си, тоест да описваме в детайли какво става в него или какво се опитваме да постигнем с даден алгоритъм.
Това е изключително полезно, когато сме работили отдавна по даден код и се върнем на по-късен етап към него, за да разберем какво точно сме се опитвали да направим.
В обектно-ориентираното програмиране коментарите позволяват директно генериране на документация, което е изключително удобно.
Коментарите ни позволяват също така да си правим бележки или да си записваме идеи за подобрение на приложението, както и да изключвате дадени части от кода.
Видове коментари в PHP
В PHP има два вида коментари - едноредови и многоредови. С едноредовите можете да коментирате нещо на един ред, докато с многоредовите имате възможност да направите по-обемен коментар на кода си.
Едноредов коментар:
<?php
//echo 'text';
?>
В настоящия пример имаме съвсем елементарен код, който би трябвало да извика текста text в браузъра, но това не става, тъй като редът е коментиран. Когато един ред бива коментиран, той автоматично бива изключен и PHP не го обработва. Самият коментар става с две наклонени черти:
//
Всичко след наклонените черти на избрания ред ще бъде изключено, коментирано.
Изключване на код с едноредов коментар:
<?php
$a=1;
//$b=2; (2)
echo $a+$b;
?>
Резултатът от това нещo e 1, тъй като кодът на ред (2) никога не се изпълнява. Това е значително по-удобно от физическото изтриване на същия код.
Многоредов коментар:
Многоредовите коментари вършат същата работа като едноредовите, но те могат да обхванат значително повече код, всъщност няма ограничение. Ето пример:
<?php
/*
echo 'muzika';
*/
?>
Тоест синтаксисът на многоредовите коментари е /* */ Всичко между двете звездички ще бъде изключено.
//TODO - специален синтаксис за неща, които желаете да отбележите, че трябва да довършите.
//BUG - синтаксис за откриване на бъгове. Отбележете места, където смятате, че има бъг/технически проблем.