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 相关文章推荐
Discuz 5.0 中读取纯真IP数据库函数分析
Mar 16 PHP
PHP file_get_contents 函数超时的几种解决方法
Jul 30 PHP
php Smarty模板生成html文档的方法
Apr 12 PHP
CI(CodeIgniter)框架介绍
Jun 09 PHP
php中eval函数的危害与正确禁用方法
Jun 30 PHP
php 使用array函数实现分页
Feb 13 PHP
php实现屏蔽掉黑帽SEO的搜索关键字
Apr 15 PHP
php根据生日计算年龄的方法
Jul 13 PHP
php开发微信支付获取用户地址
Oct 04 PHP
在Laravel中实现使用AJAX动态刷新部分页面
Oct 15 PHP
Laravel 在views中加载公共页面的实现代码
Oct 22 PHP
详解Laravel服务容器的绑定与解析
Nov 05 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
PHILIPS L4X25T电路分析和打理
2021/03/02 无线电
php性能优化分析工具XDebug 大型网站调试工具
2011/05/22 PHP
php curl模拟post提交数据示例
2013/12/31 PHP
PHPExcel读取EXCEL中的图片并保存到本地的方法
2015/02/14 PHP
php将远程图片保存到本地服务器的实现代码
2015/08/03 PHP
php递归函数三种实现方法及如何实现数字累加
2015/08/07 PHP
weiphp微信公众平台授权设置
2016/01/04 PHP
php设计模式之抽象工厂模式分析【星际争霸游戏案例】
2020/01/23 PHP
JavaScript Event学习第十章 一些可替换的事件对
2010/02/10 Javascript
js 数据类型转换总结笔记
2011/01/17 Javascript
setTimeout和setInterval的区别你真的了解吗?
2011/03/31 Javascript
js导出格式化的excel 实例方法
2013/07/17 Javascript
Jquery利用mouseenter和mouseleave实现鼠标经过弹出层且可以点击
2014/02/12 Javascript
js锁屏解屏通过对$.ajax进行封装实现
2014/07/31 Javascript
JavaScript闭包函数访问外部变量的方法
2014/08/27 Javascript
JavaScript link方法入门实例(给字符串加上超链接)
2014/10/17 Javascript
jquery使用each方法遍历json格式数据实例
2015/05/18 Javascript
JS+CSS实现的经典tab选项卡效果代码
2015/09/16 Javascript
[原创]SyntaxHighlighter自动识别并加载脚本语言
2017/02/07 Javascript
Vue.js父与子组件之间传参示例
2017/02/28 Javascript
vue组件watch属性实例讲解
2017/11/07 Javascript
Vue-Access-Control 前端用户权限控制解决方案
2017/12/01 Javascript
让mocha支持ES6模块的方法实现
2020/01/14 Javascript
[02:03]DOTA2亚洲邀请赛 HGT战队出场宣传片
2015/02/07 DOTA
[36:33]完美世界DOTA2联赛循环赛 Matador vs Forest 第一场 11.06
2020/11/06 DOTA
python轻松实现代码编码格式转换
2015/03/26 Python
python实现mysql的单引号字符串过滤方法
2015/11/14 Python
windows上安装python3教程以及环境变量配置详解
2019/07/18 Python
原生python实现knn分类算法
2019/10/24 Python
html5 canvas合成海报所遇问题及解决方案总结
2017/08/03 HTML / CSS
STAY JAPAN台湾:预订日本民宿
2018/07/22 全球购物
经典c++面试题四
2015/05/14 面试题
为什么UNION ALL比UNION快
2016/03/17 面试题
中学家长会邀请函
2014/01/17 职场文书
工程采购员岗位职责
2014/03/09 职场文书
个人德育工作总结
2015/03/05 职场文书