phpdocumentor 标识

   文档标识的应用范围是指该标识没成绩用来修饰的KEYexpress,或更多相关文档标识。
所有的文档标识都是在每一行的 * 后面以@开头。假如在一段话的中间出来@的标识,那个标识将会被当做普通内容而被忽略掉。


@
应用范 围:class,function,var,define,module
该标识用于指明KEYexpress的存取权限:private、 public或proteced
@author
指明作者
@copyright
应用范 围:class,function,var,define,module,use
指明版权消息
@deprecated
应用范 围:class,function,var,define,module,constent,global,include
指明不用或者废弃的 KEYexpress
@for instance
该标识用于解析一段文档内容,并将她们高亮显示。Phpdoc会试图从该标识给的文档路 径中读取文档内容
@const
应用范围:define
用来指明php中define的常量
@final
应用范 围:class,function,var
指明KEYexpress是一个的最终的类、窍门、属性,禁止派生、改正。
@filesource
和for instance类似,只不过该标识将直接读取当前解析的php文档的内容并显示。
@global
指明在此参数中引用的全局变量
@ingore
用 于在文档中忽略指定的KEYexpress
@license
相当于静态网页标签中的<a>,首先是URL,接着是要显示的内 容
例如<a href=”http://www.baidu.com”>百度</a>
没成绩书面表达 @license http://www.baidu.com 百度
@link
类似于license
但还没成绩经过link指到 文档中的任何一个的KEYexpress
@title
为KEYexpress指定一个的别名。
@package
应用范 围:页面级别的-> define,function,include
类级别的->class,var,methods
用于 逻辑上将一个的或几个KEYexpress分到一组。
@abstrcut
说明当前类是一个的抽象类
@param
指明一个 的参数的参数
@rechanging
指明一个的窍门或参数的返回指
@static
指明关建字是静态的。
@var
指 明变量类别
@version
指明版本消息
@todo
指明应该改进或没有出现的地方
@throws
指明此 参数估计抛出的错误异常,极其除了的情况
上面提到过,普通的文档标识标识必需在每行的开头以@标识,除此之外,还有一种标识叫做inline tag,用{@}表明,具体包括以下几种:
{@link}
应用同@link
{@source}
显示一段参数或窍门的内容

你可能感兴趣的:(PHP,职场,休闲,标识,documentor)