PHP注释

注释(Comments)是指在程序编写过程中,对程序文件或者代码片段额外添加的一个备注说明。通过注释可以提高代码可读性,让自己或其他开发人员更快速地理解程序的。

注释在程序编程中非常重要,恰当的注释程序不仅是程序员的个人习惯,更是责任的体现。但在实际过程中,大部分程序员都没有良好的对程序进行注释习惯,这往往会在日后对自己或他人造成相当大的麻烦。

PHP 注释不属于 PHP 程序的一部分,其内容也不参与程序中的任何功能计算,在编辑器中以特殊颜色(如绿色)显示。

PHP 注释符号

PHP 支持 C++,C 和 Unix Shell 风格(Perl 风格)的注释,所以也产生了 3 种PHP注释符号:

  • C++ 风格:// 这是 C+ 风格的注释
  • C 风格:/* 这是 C 风格的注释 */
  • Unix Shell 风格:# 这是 Unix Shell 风格的注释

一般大家都习惯使用 C 风格与 C++ 风格的注释。

PHP 注释格式

PHP 注释格式分为单行注释与多行注释。

1.PHP 单行注释

以上三种符号都可用于单行注释,只是使用 // 或 # 注释符时,注释符号后面的文本(本行内)都被视作注释内容,而 /* */ 风格注释符必须以 */ 结尾。

例子:

<?php
// 这是单行注释
echo '你好!'; // 这是单行注释,写在一行代码后面也叫行尾注释
/* 这个注释风格也不错 */
# 较少用的风格
?>

上面的行尾注释,通常只是对本行前面的内容进行注释,单写一行的注释可能是对下面的一行或多行代码进行注释,也可能是为了程序的整体美观。

2.PHP 多行注释

多行注释一般使用 C 风格注释符,以 /* 开头,*/ 结尾来包含多行注释内容:

<?php
echo "你好!"; 
/*
这是多行大块注释
这里面都是注释内容
更多注释内容等
*/
?>

注意:不要嵌套使用 C 风格注释符,因为在碰到第一个 */ 时系统即认为该段注释结束,在注释掉一大块代码时很容易出现该错误。如下述用法将产生 PHP 语法错误:

<?php
echo '你好!'; 
/*
这是多行大块注释
echo '输出另一些内容';  /* 添加的本行注释 */
*/
?>

也可以多次使用 // 符号来注释多行代码,但一般只限于有限的几行:

<?php
// 分页显示定制
// upPage:上一页
// downPage:下一页
protected $config = array(
    'header' => '条记录',
    'prev' => '上一页',
    'next' => '下一页',
}
?>

提示:PHP 注释中不能包含 PHP 代码结束符即:?>,因为在任何地方,PHP 检测到该结束符,即认为该段 PHP 代码结束而跳出 PHP 的执行。

分享到