Източник: https://decodeweb.in/php/what-are-comments-in-php-and-why-do-we-use-them/
Всеки знае за коментарите, защото това е първото нещо, което се преподава в училищата и колежите. Казаха ни, че коментираният код никога не се изпълнява в програма, той е правилен, но не напълно, ще ви покажа в подробности в тази публикация, но нека първо преминем през неговата дефиниция.
Какво представляват коментарите в PHP?
Коментари, да бъдат на PHP или друг език за програмиране е текстътв изходния код, който не се изпълнява, когато дадена програма се компилира, интерпретира или изпълнява, тоест текстът, който пишете в коментарите не се виждат от крайните потребители. Освен това коментарите са полезни за споделяне на идея или работа на кодов блок в екип от разработчици, работещи по същия проект.
Кодовият блок може да бъде всичко, един ред код, функция, клас или самия файл. Те са важни дори за самостоятелните разработчици, тъй като коментарите могат да напомнят за идеята или алгоритъма, приложен от разработчика преди много време. Тъй като тази публикация се отнася за PHP, тогава трябва да ви дам повече подробности за коментарите за PHP.
Видове коментари в PHP
PHP поддържа коментари в стил „C“, „C++“ и Unix shell (стил Perl). Съгласно PHP стандартите има три (3) начина за коментиране на код.
Коментари на един ред/един ред
Коментарите на ред или на един ред се обозначават като // (двойни наклонени черти). Единственият ред след // става текст за коментар. Например.
‹?php
ехо „Здравей свят“; //Това е коментар от един ред
?>
Клавишна комбинация за едноредов коментар
В phpstorm IDE изберете реда или поставете курсора върху реда, който искате да коментирате, и натиснете Ctrl+/
Многоредови коментари
Многоредовите коментари се използват, когато искаме да коментираме цял блок от редове код. Текстът на коментара е ограден в /* и */. Например
‹?php
/*echo “Това е първият ред код”;
echo “Това е вторият ред код”*/
?>
Клавишна комбинация за многоредов коментар
В phpstorm IDE изберете редовете от началото до до, които искате да коментирате, и натиснете Ctrl+shift+/
Коментари към документацията / DocBlock
Това е различен вид PHP коментари, който има свой собствен стандарт — нарича се DocBlock. DocBlocks са блокове от текстове, които се използват за генериране на документация с помощта на phpDocumentor, известен също като phpDoc. Интересното е, че те са по-важни и трябва да ги използваме, ако разработваме сложен софтуерен продукт, тогава всичко трябва да е документирано.
DocBlocks са модифицирана версия на многоредови коментари и могат лесно да бъдат идентифицирани по техния различен стил. Например.
‹?php
/**
* Този коментар ще бъде добавен като текст
* за DummyClass в документацията
*/
Клас DummyClass{
/* *
* Този коментар ще бъде добавен като текст
* за DummyFunction в документацията
*/
Публична функция dummyFunction()
{
//Този коментар няма да бъдат добавени в документацията
}
}
Както можете да видите, коментарите на DocBlock започват с /** и завършват с */
Клавишна комбинация за DocBlock
В phpstorm IDE поставете курсора над името на класа или функцията, въведете /** и натиснете enter, той автоматично ще генерира DocBlock с някакво допълнително поле, което можете да премахнете за момента, защото ще видим PHP документация в друга статия.
Освен стандартните типове коментари в php, аз също използвам един различен тип коментар, който е ToDo коментар.
до коментари
todo коментарите не са нищо друго освен едноредови коментари, но след // добавяме todo. Например
‹?php
//todo Тази част ще видя след като си дойда от ваканция
?>
В phpsorm натиснете Ctrl + E и изберете TODO, ще видите всички задачи, които се нуждаят от вашето внимание.
Заключение
И така, приятели, стигнахме до края на тази публикация, където видяхме различни видове коментари в PHP и тяхното използване в нашия код и документация. Кой тип намерихте за най-полезен, кажете ми в коментарите по-долу.
