注释程序不仅是coder的个人习惯, 更是责任的体现.
那么首先抛出一个实用技巧, 快速无痛注释PHP代码段: 使用/* */注释大段程序, 一旦代码中包含/* */的话, 注释会出错, 所以换个思路使用 if(0){ … } 更好, ^_^ 历害吧, 这个可是调试时的不败利器哦
严格意义上, PHP 有四种注释. 单行注释 # 与 // , 单行注释在PHP解释时,不予编译, 所以一般用于纪录一写不太重要的注释。多行注释 /* */, C语言风格, 多行注释将和程序一起编译, 所以会增大内存的占用。
文档注释
/**
* … 文档注释
* … …
*/
上面的形式即是文档注释, 可以理解成多行注释的加强版。如PHPDoc 这样的方案可以根据它自动生成文档。更多资料>> google
我常用标签: @author, @copyright, @example, @desc, @filesource, @see, @version, @param, @return
LD 习惯只用 // 和 文档注释.
优秀的程序员不仅代码写的漂亮,注释也毫不含糊,让人一目了然~~