PHP从入门到精通(第7版)
上QQ阅读APP看书,第一时间看更新

3.2 PHP注释的应用

注释即代码的解释和说明,一般放在代码的上方或代码的尾部,用来说明代码或函数的编写人、用途、时间等。注释放在代码尾部时,代码和注释之间应以Tab键进行分隔,以方便程序阅读。注释不会影响程序的执行,程序执行时注释部分会被解释器忽略不计。

PHP支持3种注释格式,分别是单行注释、多行注释和#风格的注释。

(1)单行注释(//)来源于C++语法格式,注释部分一般写在PHP语句的上方或后方。例如:

(2)多行注释(/*…*/)来源于C语言语法格式,分为块注释和文档注释。多行注释不允许进行嵌套操作。其中,块注释示例如下:

     <?php
          /*
         $a = 1;
         $b = 2;
         echo ($a + $b);
         */
         echo 'PHP的多行注释';
     ?>

文档注释示例如下:

     <?php
          /*说明:项目工具类
          *作者:小辛
          *E-mail:mingrisoft@mingrisoft.com
          */
          class Util
          {
          /**
          *方法说明:给字符串加前缀
          *参数:String $str
          *返回值:String
          */
               function addPrefix($str)
               {
                    $str.= 'mingri';
                    return $str;
               }
          }
     ?>

(3)#风格的注释。示例代码如下:

     <?php
          echo '这是#风格的注释';  #这是#风格的单行注释
     ?>

注意

单行注释中不要出现“?>”,否则解释器会认为PHP脚本到此已结束。例如:

     <?php
      echo '这样会出错的!!!!!'  //不会看到?>会看到
     ?>

上述代码的输出结果为:这样会出错的!!!!!会看到?>