PHP文件注释标记及规范小结
2015-01-24信息快讯网
PHP文件注释标记及规范小结,php开发的朋友可以收藏下,方便以后使用,让我们的代码更专业
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 模拟POST提交的2种方法详解
PHP的curl实现get,post和cookie(实例介绍)
ThinkPHP的RBAC(基于角色权限控制)深入解析
深入PHP curl参数的详解
解析php curl_setopt 函数的相关应用及介绍
修改php.ini不生效问题解决方法(上传大于8M的文件)
与文件上传有关的php配置参数总结
php读取二进制流(C语言结构体struct数据文件)的深入解析
php启用zlib压缩文件的配置方法
joomla jce editor 解决上传中文名文件失败问题
PHP编码规范的深入探讨
深入php之规范编程命名小结
php中的注释、变量、数组、常量、函数应用介绍
PHP数据库调用类调用实例(详细注释)
PHP 文本文章分页代码 按标记或长度(不涉及数据库)
php 中的4种标记风格介绍
PHP压缩html网页代码(清除空格,换行符,制表符,注释标记)
用PHP读取超大文件的实例代码
PHP新手用的Insert和Update语句构造类
PHP中SESSION使用中的一点经验总结
PHP __autoload()方法真的影响性能吗?
phpmyadmin3 安装配置图解教程
php 注释规范
批量去除PHP文件中bom的PHP代码
PHP 代码规范小结
PHP中文件读、写、删的操作(PHP中对文件和目录操作)
PHP中获取文件扩展名的N种方法小结
php中取得文件的后缀名?
PHP统计目录下的文件总数及代码行数(去除注释及空行)
PHP开发规范手册之PHP代码规范详解
php生成的html meta和link标记在body标签里 顶部有个空行