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

3.2 PHP注释的应用

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

PHP支持3种风格的程序注释。

 单行注释(//)

这是一种来源于C++语言语法的注释模式,可以写在PHP语句的上方,也可以写在后方。

    <?php
        //这是写在PHP语句上方的单行注释
        echo '使用C++风格的注释';
    ?>
   <?php
        echo '使用C++风格的注释';      //这是写在PHP语句后面的单行注释
    ?>

 多行注释(/*…*/)

这是一种来源于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;
             }
        }
    ?>

注意

多行注释是不允许进行嵌套操作的。

 #风格的注释(#)

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

注意

在单行注释中的内容不要出现“?>”标志,因为解释器会认为PHP脚本结束,而不去执行“?>”后面的代码。例如:

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

结果为:这样会出错的!!!!!会看到?>