Komentáre v PHP - Ako fungujú komentáre v PHP? - Príklady

Úvod do komentárov v PHP

Samotné slovo komentár vyjadruje svoj význam ako niečo, čo komentuje. Ak komentujeme čokoľvek v programovom súbore PHP, nebude s kompiláciou skompilované. Kompilátor alebo tlmočník to jednoducho ignorujú. Existujú rôzne spôsoby, ako sa môžeme vyjadriť k čomukoľvek v programovacom jazyku PHP. PHP má aj možnosti jedného riadku a viacerých riadkov. V jednoriadkovom komentári tiež môžeme podľa potreby použiť znak / alebo #. V komentári by sme mali vždy písať príslušný jazyk, aby každý, kto tento kód kontroluje, mohol tento komentár prečítať a porozumieť mu.

syntax

Komentár môžeme opäť použiť v PHP nižšie uvedenými spôsobmi.

Jednoriadkový komentár:

// 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

Ako fungujú komentáre v PHP?

V okamihu, keď do kódu napíšeme komentár, bude porovnateľný so skutočným kódom ľahší. Ak sme v rovnakom súbore napísali kód a komentár, v tomto prípade sa komentár nevykoná pri spustení tohto súboru PHP. Uvidíme to isté s príkladom.

echo "This is my first PHP Program";
// this is the first program
?>

Toto poskytne iba „Toto je môj prvý program PHP“ ako výstup, nie ako časť s komentárom.

Prečo by sme mali používať komentáre?

Mali by sme použiť komentár medzi programovým kódom PHP, aby sme sa ubezpečili, že máme dostatok pomocných komentárov, aby bolo možné kód ľahko prečítať a porozumieť mu. V komentári môžeme tiež za účelom napísania segmentu kódu, zmeny dátumu, dátumu modifikácie, modifikácie atď. Vývojárovi sa dôrazne odporúča použiť poznámku v programovacom kóde, aby veci mohli pochopiť. ľahko a bez námahy, kedykoľvek je to potrebné.

Príklady

Teraz je čas vidieť nejaký rýchly príklad kontroly správania komentára v programe.

Príklad č. 1

<_?php
echo "This is my first PHP Program";
// this is the first program
?>

Výkon

Príklad č. 2

Jednoriadkový komentár v programe

kód:

<_?php
echo 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
?>

Výkon

Príklad č. 3

Viacriadkový komentár v programe

kód:

<_?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);
?>

Výkon

Všetky komentáre napísané pred akoukoľvek funkciou o tejto funkcii sa bežne nazývajú funkčnou dokumentáciou. Takže v daných scenároch môžeme tento komentár povedať ako funkčný dokument. Je veľmi pekné použiť takýto komentár. Aby bol program PHP robustnejší, máme rôzne štandardy PHP, ktoré hovoria, že by sme nemali vo vnútri funkcie používať komentár, ako to môžeme urobiť v dokumentácii funkcií.

Príklad č. 4

Zmiešaný komentár

V programovom súbore PHP môžeme kombinovať PHP a HTML. Vzhľadom na to použijeme na komentovanie časti HTML vždy metódu komentovania HTML a poznámky PHP môžu byť použité pre kód súvisiaci s PHP podľa obchodných požiadaviek. V súbore PHP-HTML môžeme použiť akýkoľvek druh PHP komentárov a HTML komentárov.

kód:


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

PHP with HTML
echo "Hello World!"; // this is PHP comment
?>


Výkon

Príklad č. 5

Jednoriadkový komentár pomocou #

Jednoradový komentár môžeme použiť aj pomocou znaku #. Uvidíme príklad toho istého kódu. Vidíme, že tento riadok komentovania nie je až taký populárny. Len veľmi málo vývojárov používa tieto druhy komentárov. Toto sa v skutočnosti odporúča pri pripomienkovaní funkčnej dokumentácie alebo dokumentácie na úrovni súborov.

kód:

<_?php
# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>

Výkon

Záver - Komentáre v PHP

Komentár je v kóde naozaj výzvou času. Komentár môžeme použiť v našom programovom súbore PHP. Pomôže nám to urobiť zrozumiteľnejší kód. Komentár by sme mali použiť pred spustením funkcie alebo triedy, pretože väčšina programovacích jazykov má svoj vlastný štandard kódu. Komentár pred akoukoľvek funkciou alebo triedou sa zvyčajne nazýva dokumentácia tejto funkcie alebo triedy.

Odporúčané články

Toto je príručka pre komentáre v PHP. Tu diskutujeme úvod, ako to funguje, prečo by sme mali používať komentáre spolu s príkladmi a výstupmi. Viac informácií nájdete aj v ďalších navrhovaných článkoch -

1. Python Kľúčové slová
2. Tlač Array v Jave
3. Čo je XPath?
4. Dedičnosť v PHP