PHP注释规范

必须注释的地方：PHP文件头和函数头

一、PHP文件头注释规范：

1    /**
2      * [description]             　　　　　　  PHP文件描述
3      * @author [author] <[email]>   　　　　　 做者信息，[做者名称]<[邮箱地址]>
4      * @version [version]                　　 当前版本号[版本号]
5      * @since [version]            　　　　　　从项目哪一个版本加入此文件，[版本]
6      */

二、PHP方法（函数）注释规范：

1     /**
2      * [function description]               　　　　方法（函数）描述
3      * @param  [type] $param1   [description]      方法（函数）传入的参数1， @param [参数类型] $参数名 [描述]
4      * @param  [type] $param2 [description]　　　　 方法（函数）传入的参数2， @param [参数类型] $参数名 [描述]
5      * @return [type]       [description]          方法（函数）的返回值，@return [返回值类型] [返回值描述]
6      */