PHP 注释文档标记
来源:互联网 发布:淘宝卖家层级交易额 编辑:程序博客网 时间:2024/05/22 12:20
转自:http://www.phpweblog.net/jig68/archive/2011/04/02/7538.html
文档标记的使用范围是指该标记可以用来修饰的关键字,或其他文档标记。
所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记,这个标记将会被当做普通内容而被忽略掉。@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标签中的,首先是URL,接着是要显示的内容
例如[url=http://bbs.phpchina.com/”http://www.jigwang.com”]PHP那些事儿[/url]
可以写作 @license http://www.jigwang.comPHP那些事儿
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名。
@package
使用范围:页面级别的-> define,function,include
类级别的->class,var,methods
用于逻辑上将一个或几个关键字分到一组。
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的。
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常,极其发生的情况
上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:
{@link}
用法同@link
{@source}
显示一段函数或方法的内容
- PHP 注释文档标记
- PHP标记、语句、注释
- PHP标记、注释、变量风格
- PHP标记风格、语句、注释
- PHP标记和代码注释
- javadoc中文档注释标记的使用
- PHP文件注释标记及规范小结
- PHP文件注释标记及规范小结
- 【html】day02_标记_注释_HTML文档类型
- 自学PHP的笔记(六)注释标记数组排序
- php——学习笔记,标记风格和注释风格
- PHP语言基础(标记、注释、变量、数组、常量、函数)
- 1.1PHP语言标记、指令分隔符、注释
- 【小结】PHP之文档注释规范PHPDoc
- PHP 编码规范 4.5 文档注释
- php通过注释自动生成文档插件
- php代码注释规范,php文档,phpdoc,phpdocuments
- Doxygen注释常用标记
- vim显示中文
- hdu 4544 湫湫系列故事——消灭兔子(贪心+优先队列)
- 给程序员的5点建议--如何成为编程高手并创业
- JS 导出Web Table到Excel Demo(最简单)
- android transfer error: Read-only file system
- PHP 注释文档标记
- MDI开发中相关问题集
- 如何获得一个整数的二进制表达中有多少个1?
- Block 编程(翻译官方文档)
- 探讨未来网站发展趋势
- Oracle rowid
- 使用frameset,怎么在session,timeout后,点击任何链接都能整体返回index页面
- mysql卸载说明
- 基于Flash的图表组件-FusionCharts