Komentáře v PHP - Jak fungují komentáře v PHP? - Příklady

Úvod do komentářů v PHP

Samotný slovní komentář vyjadřuje svůj význam jako něco, co komentuje. Pokud komentujeme cokoli v programovém souboru PHP, nebude kompilován s kódem. Kompilátor nebo tlumočník to jednoduše ignorují. Existuje několik způsobů, jak můžeme jít s komentářem k čemukoli v programovacím jazyce PHP. PHP má jeden řádek a více řádků možnosti komentáře také. V jednomřádkovém komentáři můžeme také použít / nebo # podle našeho pohodlí. V komentáři bychom měli vždy psát příslušný jazyk, aby každý, kdo tento kód kontroluje, si tento komentář mohl přečíst a porozuměl mu.

Syntax

Znovu můžeme použít komentář níže uvedenými způsoby v PHP.

Jeden řádek komentář:

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

Jak fungují komentáře v PHP?

Ve chvíli, kdy do kódu zapíšeme komentář, bude pohled ve srovnání se skutečným kódem lehčí. Pokud máme napsaný kód a komentář ve stejném souboru, v tomto případě nebude komentář spuštěn při spuštění tohoto souboru PHP. Uvidíme totéž s příkladem.

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

Toto poskytne pouze „Toto je můj první program PHP“ jako výstup, nikoli jako část s komentářem.

Proč bychom měli používat komentáře?

Měli bychom použít komentář mezi programovým kódem PHP, abychom se ujistili, že máme dost nápovědy, aby bylo možné kód snadno přečíst a porozumět mu. V komentáři můžeme také za účelem psaní segmentu kódu, změnit datum, datum modifikace, upravit atd. Pro vývojáře je vysoce doporučeno použít komentář v programovacím kódu, aby věci byly srozumitelné snadno a bez námahy, kdykoli je to potřeba.

Příklady

Nyní je čas vidět nějaký rychlý příklad kontroly chování komentáře v programu.

Příklad č. 1

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

Výstup

Příklad č. 2

Jeden řádek v programu

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ýstup

Příklad č. 3

Víceřádkový komentář v programu

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ýstup

Jakékoli komentáře napsané před jakoukoli funkcí o této funkci se běžně nazývají funkční dokumentací. Takže v daných scénářích můžeme tento komentář říci jako funkční dokument. Je opravdu hezké použít tento komentář. Aby byl program PHP robustnější, máme různé standardy PHP, které říkají, že bychom neměli používat komentář uvnitř funkce, jak to můžeme udělat ve funkční dokumentaci.

Příklad č. 4

Smíšený komentář

V programovém souboru PHP můžeme kombinovat PHP a HTML. Vzhledem k tomu použijeme pro komentování HTML části metodu komentování HTML, kdykoli je to možné, a PHP poznámky lze použít pro kód související s PHP podle obchodních požadavků. Můžeme použít jakýkoli druh komentářů PHP a HTML komentářů v souboru PHP-HTML.

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ýstup

Příklad č. 5

Jednolínkový komentář pomocí #

Jediný řádek můžeme použít také pomocí #. Uvidíme příklad stejného kódu. Vidíme, že tento řádek komentářů není tak populární. Jen velmi málo vývojářů používá tyto druhy komentářů. To je skutečně doporučeno při komentování funkční dokumentace nebo dokumentace na úrovni souborů.

Kód:

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

Výstup

Závěr - Komentáře v PHP

Komentář je v kódu opravdu výzvou času. Komentář můžeme použít v našem programovém souboru PHP. To nám pomůže zlepšit srozumitelnost kódu. Komentář bychom měli použít před spuštěním funkce nebo třídy, protože většina programovacích jazyků má svůj vlastní standard kódu. Komentář před jakoukoli funkcí nebo třídou obvykle nazýval dokumentaci této funkce nebo třídy.

Doporučené články

Toto je průvodce Poznámky v PHP. Zde diskutujeme úvod, jak to funguje, proč bychom měli používat komentáře spolu s příklady a výstupy. Další informace naleznete také v dalších navrhovaných článcích -

1. Python Klíčová slova
2. Tisk pole v Javě
3. Co je XPath?
4. Dědičnost v PHP