php代码注释说明

  在网站建设中，代码注释可以理解为代码中的解释和说明，是程序中不可缺少的一个重要元素，使用注释不仅能够提高程序的可读性，而且有利于创新的后期维护工作。注释不会影响程序的执行，因为在执行时，注释的内容不会被解释器执行。

  php注释风格主要有三种，一下分别举例说明：
  1、C++风格的单行注释  “ // ”
     <?php

        echo "php中C++风格的单行注释";                  //echo "这就是C++风格的单行注释";

      ?>

  上式运行输出：php中C++风格的单行注释


2、C风格的多行注释     "/*....*/"
    <?php
       /*
       echo "这里是第一行注释的内容，不好输出";
       echo"这里是第二行注释的内容，不会输出";

      */
    echo "使用C风格的注释";

   ?>


上式运行输出：使用C风格的注释

3、Shell风格的注释    " # "
   <?php
  echo "这是Shell脚本风格的注释";              #这里的内容是看不到的

?>

特别需要注意的是：在使用单行注释时，注释内容中不要出现“ ?/ ”标志，因为解释器会认为这是php脚本而去执行 ?> 后面的代码。
例如：
    <?php
      echo"这样写注释会出错的！！！！！";    //不会看到?>  会看到

?>

合理使用注释有以下几项原则：
1、注释语言必须准确、易懂、简洁；
2、注释在编译代码时会被忽略，不会编译到最后的可执行文件中，所以注释不会增加可执行文件的大小；
3、注释可以书写在代码中的任何位置，但一般写在代码的开头或结束位置(避免在一行代码或表达式的中间插入注释，否则容易使代码的可读性变差)；
4、修改代码程序使，一定要同时修改注释语句，保持代码和注释的同步；
5、在程序块的结束位置加注释说明，以表明某程序块的结束；
6、避免在注释中使用缩写，别人看不懂你创造的缩写词；
7、在实际代码规范中，要求注释占程序代码的比例为20%左右。