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的in_array低性能问题
Sep 17 PHP
PHP常用正则表达式集锦
Aug 17 PHP
PHP实现支持GET,POST,Multipart/form-data的HTTP请求类
Sep 24 PHP
使用URL传输SESSION信息
Jul 14 PHP
两种php给图片加水印的实现代码
Apr 18 PHP
深入php内核之php in array
Nov 10 PHP
学习php设计模式 php实现享元模式(flyweight)
Dec 07 PHP
PHP计算日期相差天数实例分析
Feb 23 PHP
php实现产品加入购物车功能(1)
Jul 23 PHP
php单元测试phpunit入门实例教程
Nov 17 PHP
php 广告点击统计代码(php+mysql)
Feb 21 PHP
Laravel 微信小程序后端实现用户登录的示例代码
Nov 26 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
菜鸟修复电子管记
2021/03/02 无线电
php设计模式 Decorator(装饰模式)
2011/06/26 PHP
php微信开发之关注事件
2018/06/14 PHP
YII框架http缓存操作示例
2019/04/29 PHP
PHP开发api接口安全验证操作实例详解
2020/03/26 PHP
JQuery 获取和设置Select选项的代码
2010/02/07 Javascript
初识javascript 文档碎片
2010/07/13 Javascript
javascript 保存文件到本地实现方法
2012/11/29 Javascript
js基础知识(公有方法、私有方法、特权方法)
2015/11/06 Javascript
javascript html5 canvas实现可拖动省份的中国地图
2016/03/11 Javascript
javascript简单判断输入内容是否合法的方法
2016/05/11 Javascript
老生常谈combobox和combotree模糊查询
2017/04/17 Javascript
详解使用vue脚手架工具搭建vue-webpack项目
2017/05/10 Javascript
jQuery实现的中英文切换功能示例
2019/01/11 jQuery
ES6 Object方法扩展的应用实例分析
2019/06/25 Javascript
Vue组件化开发之通用型弹出框的实现
2020/02/28 Javascript
uniapp实现可滑动选项卡
2020/10/21 Javascript
python实现得到一个给定类的虚函数
2014/09/28 Python
python smtplib模块实现发送邮件带附件sendmail
2018/05/22 Python
python检测IP地址变化并触发事件
2018/12/26 Python
在Python中通过getattr获取对象引用的方法
2019/01/21 Python
在django-xadmin中APScheduler的启动初始化实例
2019/11/15 Python
python模拟预测一下新型冠状病毒肺炎的数据
2020/02/01 Python
python手写均值滤波
2020/02/19 Python
30行Python代码实现高分辨率图像导航的方法
2020/05/22 Python
美国购买和销售礼品卡平台:Raise
2017/01/13 全球购物
Godiva巧克力英国官网:比利时歌帝梵巧克力
2018/08/28 全球购物
美国购物网站:Clickhere2shop
2021/01/28 全球购物
电子商务专业推荐信范文
2013/12/02 职场文书
关于赌博的检讨书
2014/01/08 职场文书
市场营销方案范文
2014/03/11 职场文书
党的群众路线教育实践活动个人整改措施
2014/10/27 职场文书
父亲婚礼答谢词
2015/01/04 职场文书
Python可变集合和不可变集合的构造方法大全
2021/12/06 Python
疑《守望先锋2》A测截图泄露 或将推出新模式、新界面
2022/04/03 其他游戏
Golang获取List列表元素的四种方式
2022/04/20 Golang