Wprowadzenie do komentarzy w PHP
Samo słowo komentarz wyraża swoje znaczenie jako komentowanie czegoś. Jeśli komentujemy coś w pliku programu PHP, nie zostanie on skompilowany z kodem. Kompilator lub interpreter po prostu to zignoruje. Istnieją różne sposoby komentowania czegokolwiek w języku programowania PHP. PHP ma także opcje komentowania pojedynczej linii i wielu linii. Ponadto w komentarzu jednowierszowym możemy użyć / lub # zgodnie z naszą wygodą. Powinniśmy zawsze pisać odpowiedni język w komentarzu, aby każdy, kto recenzuje ten kod, mógł przeczytać i zrozumieć ten komentarz.
Składnia
Ponownie możemy użyć komentarza w niżej wymienionych sposobach w PHP.
Komentarz jednowierszowy:
// 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 działa Komentarze w PHP?
W chwili, gdy napiszemy komentarz w kodzie, będzie on jaśniejszy w porównaniu do rzeczywistego kodu. Jeśli w tym samym pliku zapisaliśmy kod i komentarz, w tym przypadku komentarz nie zostanie wykonany podczas uruchamiania tego pliku PHP. Zobaczmy to samo na przykładzie.
echo "This is my first PHP Program";
// this is the first program
?>
To da tylko „To jest mój pierwszy program PHP” jako wynik, a nie część komentarza.
Dlaczego powinniśmy używać komentarzy?
Powinniśmy używać komentarza pomiędzy kodem programu PHP, aby upewnić się, że mamy wystarczająco dużo komentarzy, aby można było łatwo odczytać i zrozumieć kod. W komentarzu możemy również w celu napisania segmentu kodu, zmienić datę, datę modyfikacji, zmodyfikować itp. Zaleca się, aby programista używał komentarza w kodzie programowania, aby wszystko było zrozumiałe łatwo, przy niewielkim lub żadnym wysiłku, gdy jest to wymagane.
Przykłady
Teraz nadszedł czas, aby zobaczyć szybki przykład sprawdzenia zachowania komentarza w programie.
Przykład 1
<_?phpecho "This is my first PHP Program";
// this is the first program
?>
Wynik
Przykład nr 2
Komentarz jednowierszowy w programie
Kod:
<_?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
?>
Wynik
Przykład nr 3
Komentarz do wielu wierszy w programie
Kod:
<_?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);
?>
Wynik
Wszelkie komentarze napisane przed jakąkolwiek funkcją na temat tej funkcji są powszechnie znane jako dokumentacja funkcji. Tak więc w podanych scenariuszach możemy wypowiedzieć ten komentarz jako dokument funkcji. Naprawdę miło jest użyć takiego komentarza. Aby uczynić program PHP bardziej niezawodnym, mamy różne standardy PHP, które mówią, że nie powinniśmy używać komentarza wewnątrz funkcji, ponieważ możemy zrobić to samo w dokumentacji funkcji.
Przykład 4
Mieszany komentarz
W pliku programu PHP możemy łączyć zarówno PHP, jak i HTML. Biorąc to pod uwagę, użyjemy metody komentowania HTML, aby w razie potrzeby skomentować część HTML, a komentarze PHP mogą być użyte dla kodu związanego z PHP zgodnie z wymaganiami biznesowymi. Możemy użyć dowolnego rodzaju komentarzy PHP i komentarzy HTML w pliku PHP-HTML.
Kod:
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
?>
Wynik
Przykład 5
Komentarz jednowierszowy przy użyciu #
Możemy użyć komentowania w jednym wierszu, używając również #. Zobaczmy przykład kodu dla tego samego. Widzimy, że ta linia komentarzy nie jest zbyt popularna. Bardzo niewielu programistów używa tego rodzaju komentarzy. Jest to naprawdę zalecane podczas komentowania dokumentacji funkcji lub dokumentacji na poziomie pliku.
Kod:
<_?php# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
Wynik
Wniosek - komentarze w PHP
Komentarz jest w rzeczywistości kodem czasu. Możemy użyć komentarza w naszym pliku programu PHP. Pomoże nam to uczynić kod bardziej zrozumiałym. Powinniśmy użyć komentarza przed uruchomieniem funkcji lub klasy, ponieważ większość języków programowania ma swój własny standard kodu. Zazwyczaj komentarz przed jakąkolwiek funkcją lub klasą nazywał dokumentację tej funkcji lub klasy.
Polecane artykuły
To jest przewodnik po komentarzach w PHP. Tutaj omawiamy wprowadzenie, jak to działa, dlaczego powinniśmy używać komentarzy wraz z przykładami i wynikami. Możesz także przejrzeć nasze inne sugerowane artykuły, aby dowiedzieć się więcej -
- Słowa kluczowe w języku Python
- Drukuj tablicę w Javie
- Co to jest XPath?
- Dziedziczenie w PHP