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 相关文章推荐
PHP5新特性: 更加面向对象化的PHP
Nov 18 PHP
php 无法载入mysql扩展
Mar 12 PHP
php关于array_multisort多维数组排序的使用说明
Jan 04 PHP
鸡肋的PHP单例模式应用详解
Jun 03 PHP
解析thinkphp中的导入文件标签
Jun 20 PHP
php加速器eAccelerator的配置参数、API详解
May 05 PHP
Python中使用django form表单验证的方法
Jan 16 PHP
laravel中命名路由的使用方法
Feb 24 PHP
php利用云片网实现短信验证码功能的示例代码
Nov 18 PHP
Smarty模板语法详解
Jul 20 PHP
php实现session共享的实例方法
Sep 19 PHP
解决PhpStorm64不能启动的问题
Jun 20 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制作简单的内容采集器的原理分析
2008/10/01 PHP
Ajax+PHP边学边练 之五 图片处理
2009/12/03 PHP
PhpMyAdmin中无法导入sql文件的解决办法
2010/01/08 PHP
php输出xml格式字符串(用的这个)
2012/07/12 PHP
使用php实现快钱支付功能(涉及到接口)
2013/07/01 PHP
PHP输出缓存ob系列函数详解
2014/03/11 PHP
php实现获取局域网所有用户的电脑IP和主机名、及mac地址完整实例
2014/07/18 PHP
MacOS 安装 PHP的图片裁剪扩展Tclip
2015/03/25 PHP
PHP设计模式之命令模式示例详解
2020/12/20 PHP
javascript import css实例代码
2008/07/18 Javascript
web的各种前端打印方法之jquery打印插件PrintArea实现网页打印
2013/01/09 Javascript
原生JS实现加入收藏夹的代码
2013/10/24 Javascript
移动节点的jquery代码
2014/01/13 Javascript
javascript获取web应用根目录的方法
2014/02/12 Javascript
js实现类似新浪微博首页内容渐显效果的方法
2015/04/10 Javascript
js实现圆盘记速表
2015/08/03 Javascript
Spring mvc 接收json对象
2015/12/10 Javascript
JS实现的驼峰式和连字符式转换功能分析
2016/12/21 Javascript
jQuery滚动监听实现商城楼梯式导航效果
2017/03/06 Javascript
原生JS实现的多个彩色小球跟随鼠标移动动画效果示例
2018/02/01 Javascript
微信小程序自定义组件实现tabs选项卡功能
2018/07/14 Javascript
vue子组件改变父组件传递的prop值通过sync实现数据双向绑定(DEMO)
2020/02/01 Javascript
简单了解JavaScript弹窗实现代码
2020/05/07 Javascript
[05:45]Ti4观战指南(下)
2014/07/07 DOTA
python服务器端收发请求的实现代码
2014/09/29 Python
为python设置socket代理的方法
2015/01/14 Python
Python数据操作方法封装类实例
2017/06/23 Python
python SSH模块登录,远程机执行shell命令实例解析
2018/01/12 Python
用Python写一个模拟qq聊天小程序的代码实例
2019/03/06 Python
英国著名的药妆网站:Escentual
2016/07/29 全球购物
布鲁明戴尔百货店:Bloomingdale’s
2016/12/21 全球购物
墨尔本最受欢迎的复古风格品牌:Princess Highway
2018/12/21 全球购物
电脑租赁公司创业计划书
2014/01/08 职场文书
2014年精神文明建设工作总结
2014/11/19 职场文书
2015年毕业实习工作总结
2014/12/12 职场文书
初一英语教学反思
2016/02/15 职场文书