PHP代码注释写法

PHP 注释格式

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

PHP 单行注释

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

例子：

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

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

PHP 多行注释

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

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

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

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

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

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

提示

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