Въведение в коментарите в PHP
Самата дума коментар изразява своето значение като коментиране на нещо. Ако коментираме нещо в програмния файл на PHP, той няма да бъде компилиран с кода. Компилаторът или преводачът просто ще игнорира това. Има различни начини да коментираме каквото и да било в езика за програмиране на PHP. PHP има и един ред и опции за коментиране на няколко реда. Също така, в едноредов коментар, можем да използваме / или # според нашето удобство. Винаги трябва да напишем подходящия език в коментара, така че всеки, който преглежда този код, да може да прочете и разбере този коментар.
Синтаксис
Отново можем да използваме коментара по споменатите по-долу начини в PHP.
Коментар в една линия:
// This is a single-line comment
# This is a single-line comment
/*
This is a multiple line comment – line no – 1
This is a multiple line comment – line no – 2
… and so on …
*/
# this is the single-line comment
; this is a PHP.INI style commenting
Как работят коментарите в PHP?
В момента, в който напишем коментара в кода, той ще бъде по-лек с оглед сравнително в сравнение с действителния код. Ако имаме написан код и коментара в един и същ файл, в този случай коментарът няма да бъде изпълнен, докато работи този PHP файл. Така че нека да видим същото с пример.
echo "This is my first PHP Program";
// this is the first program
?>
Това ще даде само „Това е първата ми програма за PHP“ като изход, а не частта за коментар.
Защо трябва да използваме коментари?
Трябва да използваме коментара между PHP програмния код, за да сме сигурни, че имаме достатъчно помощни коментари, така че човек да може лесно да прочете и разбере кода. В коментар можем също така с цел да напишем сегмента на кода, да променим датата, датата на модификация, променена от и т.н. Настоятелно се препоръчва на разработчика да използва коментара в програмния код, така че нещата да бъдат разбрани лесно с малко или никакви усилия, когато се изисква.
Примери
Сега е време да видим някакъв бърз пример проверката на поведението на коментара в програмата.
Пример №1
<_?phpecho "This is my first PHP Program";
// this is the first program
?>
продукция
Пример №2
Единичен коментар в програмата
Код:
<_?phpecho date_default_timezone_get(); //to get the timezone
echo "
"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>
продукция
Пример №3
Многоредов коментар в програмата
Код:
<_?php/*
This is a function that will take time in minutes and will return that in hours and minutes
We use will this function further to test with some examples.
*/
function hoursandmins($minutes, $format = '%01d Hours, %02d Minutes')
(
if ($minutes < 1) (
return;
)else if($minutes<10)(
if($minutes==1)(
return '0'.$minutes.' Minute';
)
return '0'.$minutes.' Minutes';
)else if($minutes<50)(
return $minutes.' Minutes';
)
$hours = floor($minutes / 60);
$minutes = ($minutes % 60);
$format = "";
if($hours>0)(
if($hours>1)(
$format .= '%01d Hours';
)else(
$format .= '%01d Hour';
)
)
if($hours>0 && $minutes>0)(
$format .= ', ';
)
if($minutes>0)(
if($minutes>1)(
$format .= ' %02d Minutes';
)else(
$format .= ' %01d Minute';
)
)
return sprintf($format, $hours, $minutes);
)
// time to check the time in descriptive form
echo hoursandmins(20);
echo "
";
echo hoursandmins(120);
?>
продукция
Всички коментари, написани преди някоя функция за тази функция, обикновено са известни като документация за функцията. Така че в дадените сценарии можем да кажем този коментар като функционален документ. Това е наистина хубаво да използвате коментара така. За да направим PHP програмата по-здрава, имаме различни PHP стандарти, които казват, че не трябва да използваме коментара във функцията, тъй като можем да направим същото в документацията за функциите.
Пример №4
Смесен коментар
В програмен файл на PHP можем да комбинираме както PHP, така и HTML. Като се има предвид това, ще използваме метода за коментиране на HTML, за да коментираме HTML частта, когато е необходимо, и коментарите на PHP могат да се използват за кода, свързан с PHP, според бизнес изискванията. Можем да използваме всякакъв вид коментари на PHP и HTML коментари във PHP-HTML файл.
Код:
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
продукция
Пример №5
Коментар от един ред с помощта на #
Можем да използваме кодирането на един ред и с помощта на #. Нека видим пример за кода за същото. Виждаме, че този ред на коментари не е толкова популярен. Много малко разработчици използват този вид коментари. Това наистина се препоръчва, докато коментирате документацията за функциите или документацията на ниво файл.
Код:
<_?php# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
продукция
Заключение - Коментари в PHP
Един коментар наистина е призив на време в кода. Можем да използваме коментара в нашия PHP програмен файл. Това ще ни помогне да направим кода по-разбираем. Трябва да използваме коментара преди да стартираме функция или клас, тъй като повечето езици за програмиране имат свой стандарт за код. Обикновено коментарът преди която и да е функция или клас нарича документация на тази функция или класа.
Препоръчителни статии
Това е ръководство за Коментари в PHP. Тук обсъждаме въвеждането, Как работи, защо трябва да използваме коментари заедно с Примери и резултати. Можете също да прегледате и другите ни предложени статии, за да научите повече -
- Ключови думи на Python
- Печат на масив в Java
- Какво е XPath?
- Наследяване в PHP