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 文件时注释将不会被执行。让我们通过一个例子来看看。

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

这只会给出“这是我的第一个 PHP 程序”作为输出，而不是注释部分。

为什么我们应该使用注释？

我们应该在 PHP 程序代码之间使用注释，以确保我们有足够的帮助注释，以便人们可以轻松阅读和理解代码。在注释中，我们还可以出于编写代码段的目的，更改日期、修改日期、修改者等。强烈建议开发人员在编程代码中使用注释，以便能够理解事情只要需要，只需很少的努力或根本不需要努力即可轻松完成。

示例

现在，是时候看一些快速示例来检查程序中评论的行为了。

示例#1

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

输出

示例#2

程序中的单行注释

代码：

<?php echo date_default_timezone_get(); //to get the timezone
echo "<br>"; //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 "<br>";
echo hoursandmins(120);
?>

输出

在任何函数之前编写的有关该函数的任何注释通常称为函数文档。因此，在给定的场景中，我们可以将此注释视为功能文档。使用这样的评论真是太好了。为了使 PHP 程序更加健壮，我们有各种 PHP 标准，规定我们不应在函数内使用注释，因为我们可以在函数文档中执行相同的操作。

示例#4

褒贬不一的评论

在PHP程序文件中，我们可以将PHP和HTML结合起来。考虑到这一点，我们将在需要时使用HTML注释方法将HTML部分注释掉，而PHP注释可以根据业务需求用于PHP相关代码。我们可以在 PHP-HTML 文件中使用任何类型的 PHP 注释和 HTML 注释。

代码：

<h1 id="PHP-with-HTML">PHP with HTML</h1>
<!-- this is html comment -->
<?php 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中文网其他相关文章！