码迷,mamicode.com
首页 > Web开发 > 详细

PHP注释规范

时间:2015-09-09 11:16:14      阅读:137      评论:0      收藏:0      [点我收藏+]

标签:

必须注释的地方:PHP文件头和函数头
1、PHP文件头注释规范:
1    /**
2      * [description]                     PHP文件描述
3      * @author [author] <[email]>         作者信息,[作者名称]<[邮箱地址]>
4      * @version [version]                   当前版本号[版本号]
5      * @since [version]                  从项目哪个版本加入此文件,[版本]
6      */
2、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      */

 

PHP注释规范

标签:

原文地址:http://www.cnblogs.com/code-ten/p/4793872.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!