腾讯云618限量抢购
  1. PHP+MySQL数据库教程
  2. PHP进阶教程
  3. ThinkPHP 3.0/3.1 教程

PHP 注释符号与注释格式

最后更新:2011-03-27 18:19阅读:39818

PHP 注释

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

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

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

PHP 注释符号

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

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

一般大家都习惯使用 C 风格与 C++ 风格的注释。在一些系统配置文档中,如前面PHP开发环境安装章节的《Apache 安装与配置》一文中,httpd.conf 配置文件使用的就是 # 注释符号。

PHP 注释格式

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

PHP 单行注释

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

例子:

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

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

PHP 多行注释

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

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

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

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

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

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

提示

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


本章节内容共分 8 部分:
  1. 1. PHP 基本语法
  2. 2. PHP 变量
  3. 3. PHP 常量
  4. 4. PHP 注释符号与注释格式
  5. 5. PHP isset() 检测变量是否设置
  6. 6. PHP empty() 检测一个变量是否为空
  7. 7. PHP unsert() 销毁变量
  8. 8. PHP defined() 检测常量是否被定义
腾讯云618限量抢购