Введение в комментарии в 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