PHP文件注释标记及规范小结


Posted in PHP onApril 01, 2012

PHP 注释标记

@access
使用范围:class,function,var,define,module
该标记用于指明关键字的存取权限:private、public或proteced

@author
指明作者

@copyright
使用范围:class,function,var,define,module,use
指明版权信息

@deprecated
使用范围:class,function,var,define,module,constent,global,include
指明不用或者废弃的关键字

@example
该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容

@const
使用范围:define
用来指明php中define的常量

@final
使用范围:class,function,var
指明关键字是一个最终的类、方法、属性,禁止派生、修改。

@filesource
和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。

@global
指明在此函数中引用的全局变量

@ingore
用于在文档中忽略指定的关键字

@license
相当于html标签中的<a>,首先是URL,接着是要显示的内容
例如<a href=”http://www.baidu.com”>百度</a>
可以写作 @license http://www.baidu.com 百度

@link
类似于license
但还可以通过link指到文档中的任何一个关键字

@name
为关键字指定一个别名。

@package
使用范围:页面级别的-> define,function,include
类级别的->class,var,methods
用于逻辑上将一个或几个关键字分到一组。

@abstrcut
说明当前类是一个抽象类

@param
指明一个函数的参数

@return
指明一个方法或函数的返回指

@static
指明关建字是静态的。

@var
指明变量类型

@version
指明版本信息

@todo
指明应该改进或没有实现的地方

@throws
指明此函数可能抛出的错误异常,极其发生的情况

普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:

{@link}
用法同@link

{@source}
显示一段函数或方法的内容

注释规范

a.注释必须是

/**
* 注释内容
*/

的形式

b.对于引用了全局变量的函数,必须使用glboal标记。

c.对于变量,必须用var标记其类型(int,string,bool…)

d.函数必须通过param和return标记指明其参数和返回值

e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可

f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的阅读。

g.必要的地方使用非文档性注释,提高代码易读性。

h.描述性内容尽量简明扼要,尽可能使用短语而非句子。

i.全局变量,静态变量和常量必须用相应标记说明

PHP 相关文章推荐
php 数组二分法查找函数代码
Feb 16 PHP
PHP 获取MySQL数据库里所有表的实现代码
Jul 13 PHP
PHP输出时间差函数代码
Jan 28 PHP
PHP 伪静态技术原理以及突破原理实现介绍
Jul 12 PHP
Drupal7连接多个数据库及常见问题解决
Mar 02 PHP
php中数据库连接方式pdo和mysqli对比分析
Feb 25 PHP
PHP与Ajax相结合实现登录验证小Demo
Mar 16 PHP
php版阿里云OSS图片上传类详解
Dec 01 PHP
php基于ob_start(ob_gzhandler)实现网页压缩功能的方法
Feb 18 PHP
PHP微信公众号开发之微信红包实现方法分析
Jul 14 PHP
PHP判断是否是微信打开,浏览器打开的方法
Mar 14 PHP
php实现商城购物车的思路和源码分析
Jul 23 PHP
用PHP读取超大文件的实例代码
Apr 01 #PHP
PHP新手用的Insert和Update语句构造类
Mar 31 #PHP
PHP中SESSION使用中的一点经验总结
Mar 30 #PHP
PHP __autoload()方法真的影响性能吗?
Mar 30 #PHP
phpmyadmin3 安装配置图解教程
Mar 29 #PHP
php 注释规范
Mar 29 #PHP
php 计划任务 检测用户连接状态
Mar 29 #PHP
You might like
基于header的一些常用指令详解
2013/06/06 PHP
基于php中使用excel的简单介绍
2013/08/02 PHP
php使用curl打开https网站的方法
2015/06/17 PHP
php7 错误处理机制修改实例分析
2020/05/25 PHP
windows系统下简单nodejs安装及环境配置
2013/01/08 NodeJs
Jquery绑定事件(bind和live的区别介绍)
2013/08/23 Javascript
移除AngularJS下URL中的#字符的方法
2015/06/19 Javascript
jQuery点击按钮弹出遮罩层且内容居中特效
2015/12/14 Javascript
JS实现Select的option上下移动的方法
2016/03/01 Javascript
AngularJS指令中的绑定策略实例分析
2016/12/14 Javascript
jQuery实现的简单排序功能示例【冒泡排序】
2017/01/13 Javascript
Angular动态添加、删除输入框并计算值实例代码
2017/03/29 Javascript
jQuery实现的淡入淡出与滑入滑出效果示例
2018/04/18 jQuery
使用Vue 实现滑动验证码功能
2019/06/27 Javascript
基于postman获取动态数据过程详解
2020/09/08 Javascript
javascript中call,apply,bind的区别详解
2020/12/11 Javascript
[00:39]DOTA2上海特级锦标赛 Liquid战队宣传片
2016/03/04 DOTA
python使用epoll实现服务端的方法
2018/10/16 Python
python使用Turtle库绘制动态钟表
2018/11/19 Python
利用Pycharm断点调试Python程序的方法
2018/11/29 Python
Django Aggregation聚合使用方法解析
2019/08/01 Python
python实现kNN算法识别手写体数字的示例代码
2019/08/16 Python
python requests抓取one推送文字和图片代码实例
2019/11/04 Python
Pycharm中Python环境配置常见问题解析
2020/01/16 Python
keras中epoch,batch,loss,val_loss用法说明
2020/07/02 Python
python 实现控制鼠标键盘
2020/11/27 Python
用HTML5.0制作网页的教程
2010/05/30 HTML / CSS
2019年分享net面试的经历和题目
2016/08/07 面试题
审计主管岗位职责
2014/01/31 职场文书
行政文秘岗位职责范本
2014/02/10 职场文书
餐厅周年庆活动方案
2014/08/25 职场文书
关于运动会的宣传稿
2015/07/23 职场文书
小学美术教学反思
2016/02/17 职场文书
《彼得与狼》教学反思
2016/02/20 职场文书
Java实现学生管理系统(IO版)
2022/02/24 Java/Android
Redis高并发缓存架构性能优化
2022/05/15 Redis