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程序中的常见漏洞进行攻击(下)
Oct 09 PHP
php escape URL编码
Dec 10 PHP
php模块memcache和memcached区别分析
Jun 14 PHP
php中如何防止表单的重复提交
Aug 02 PHP
浅析PHP中strlen和mb_strlen的区别
Aug 31 PHP
php中运用http调用的GET和POST方法示例
Sep 29 PHP
PHP基于GD库的图像处理方法小结
Sep 27 PHP
PHP封装的XML简单操作类完整实例
Nov 13 PHP
phpcms实现验证码替换及phpcms实现全站搜索功能教程详解
Dec 13 PHP
PHP获取二叉树镜像的方法
Jan 17 PHP
PHP常用日期加减计算方法实例小结
Jul 31 PHP
thinkphp5使用无限极分类
Feb 18 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
PHP中的session永不过期的解决思路及实现方法分享
2011/04/20 PHP
关于PHP二进制流 逐bit的低位在前算法(详解)
2013/06/13 PHP
ThinkPHP3.1新特性之Action参数绑定
2014/06/19 PHP
Yii基于CActiveForm的Ajax数据验证用法示例
2016/07/14 PHP
PHP7标量类型declare用法实例分析
2016/09/26 PHP
thinkPHP引入类的方法详解
2016/12/08 PHP
关于PHP通用返回值设置方法
2017/03/31 PHP
php往mysql中批量插入数据实例教程
2018/12/12 PHP
用js判断用户浏览器是否是XP SP2的IE6
2007/03/08 Javascript
jsvascript图像处理—(计算机视觉应用)图像金字塔
2013/01/15 Javascript
火狐下table中创建form导致两个table之间出现空白
2013/09/02 Javascript
鼠标移到div,浮层显示明细,弹出层与div的上边距左边距重合(示例代码)
2013/12/14 Javascript
JS判断字符串字节数并截取长度的方法
2016/03/05 Javascript
jQuery实现点击水纹波动动画
2016/04/10 Javascript
浅析在javascript中创建对象的各种模式
2016/05/06 Javascript
JavaScript知识点总结(五)之Javascript中两个等于号(==)和三个等于号(===)的区别
2016/05/31 Javascript
jQuery的事件预绑定
2016/12/05 Javascript
基于$.ajax()方法从服务器获取json数据的几种方式总结
2018/01/31 Javascript
Angular使用动态加载组件方法实现Dialog的示例
2018/05/11 Javascript
Vue 如何使用props、emit实现自定义双向绑定的实现
2020/06/05 Javascript
在vue项目中引用Antv G2,以饼图为例讲解
2020/10/28 Javascript
编写Python脚本批量下载DesktopNexus壁纸的教程
2015/05/06 Python
Python的randrange()方法使用教程
2015/05/15 Python
Python3中简单的文件操作及两个简单小实例分享
2017/06/18 Python
Python查找数组中数值和下标相等的元素示例【二分查找】
2019/02/13 Python
State Cashmere官网:半零售价可持续蒙古羊绒
2020/02/26 全球购物
新锐科技Java程序员面试题
2016/07/25 面试题
捐助贫困学生倡议书
2014/05/16 职场文书
励志演讲稿大全
2014/08/21 职场文书
新党章心得体会
2014/09/04 职场文书
个人年度总结报告
2015/03/09 职场文书
2015年读书月活动总结
2015/03/26 职场文书
楚门的世界观后感
2015/06/03 职场文书
新娘父亲婚礼致辞
2015/07/27 职场文书
2016年大学生就业指导课心得体会
2015/10/09 职场文书
Python实现猜拳与猜数字游戏的方法详解
2022/04/06 Python