PHP 代码注释

写在前面

注释可以理解成代码中的解释和说明。使用注释不仅能提高程序的可读性，而且有利于程序的后期维护工作，注释内容不会被程序所执行。

个人项目

个人站点：<a href="http://film.noasis.cn">LN电影网</a>
个人博客：<a href="http://blog.noasis.cn">L&N博客</a>

PHP 的注释

PHP 注释有 3 中风格

1. C++ 风格的单行注释 （//）

// 这是一条注释信息：打印 hello world
echo 'hello world';

2. C++ 风格的多行注释 （/**/）

 /* 这是一个多行注释
       echo '你好';
       echo ‘这个世界’;
    */

echo "你好这个世界";

3. 使用 Shell 风格的注释（#）

跟 单行注释类似，# 所在行不会被执行

echo '你好这个世界'; # shell 风格注释，这里的内容不会被执行

PHP 的有效注释

程序注释是书写规范程序是很重要的环节。注释主要是针对代码的解释与说明，主要作用如下：解释脚本用途、版权说明、版本号、生成日期、作者、内容等等。有助于对程序的阅读理解

注释原则

语言

• 注释语言必须准确、易懂、简洁

说明： 错误的注释不但无益反而有害

• 注释在编译代码时会被忽略，不会被编译器编译到最后的可执行文件中，所以注释不会增加执行文件大小。

• 注释可以书写在代码中的任意位置，但是一般写在代码的开头或者结束位置

说明：避免在一行代码或者表达式中间插入注释。否则容易产生理解偏差

• 修改程序代码时，一定要同时修改相关的注释，保证代码和注释的同步

• 在实际代码规范中，要求注释代码占程序代码的比例达到 20% 左右，即 100 行代码有 20 行注释

说明: 防止不必要的注释

• 在程序块的结束行右方添加注释，以表明某段程序快结束

• 避免在注释中使用缩写，特别是非常用缩写

• 注释与所描述内容同样的缩写，可以使程序排版整齐，并且方便注释的阅读与理解

总结

如果想成为一名严谨、有态度的程序员，这些看似无关紧要的原则其实代表了我们对所编写程序的一种负责态度。