phpDoc

@global

@global 用法

@global datatype $globalvariablename
@global datatype description

phpDocumentor 通过在文本块中使用 @global 标签来执行全局变量的声明。为了支持以前的 @global 用法,有两种方法使用 @global 标签,即变量定义和函数说明。

phpDocument 不会自动解析任何 @global 标签,且每个文本块中只能使用一个 @global 标签。一个全局变量文本块必须在其它任何元素或文本块这前,否则则会出现错误。

datetype 可以是任意有效的PHP类型或者 "mixed"。

$varname 必须是与源文件中声明的全局变量一致(使用 @name 标签可以改变名称在文档中的显示)。

未完...

应用示例:

@filesource

  @filesource 标签只可作为文档级文本块(DocBlock)的应用,在其它地方使用此标签都将被忽略。phpDocumentor 解析当前文件的源代码,将其源代码进行语法高亮、添加行号,并且在生成的文档中添加它的链接。

  @example 标签的意图与其相似,区别在于 @example 用于解析和创建链接到外部文件。

注意:@filesource 标签只在 PHP 4.3.0 中使用。

应用示例:

@final

  @final 用于通告一个方法不能被子类覆写

@final 标签只能在使用 final 关键词的PHP4和PHP5中使用

应用示例:

@deprecated

  @deprecate 标签可以应用于那些已经废弃的版本或声明一些相关信息的元素,除了页面之外,@deprecated 可应用于全局变量(global variable)、引用(include)、常量(constant)、函数(function)、定义(define)、类(class)、变量 (variable)、方法(method)。phpDocumentor 将直接显示 @deprecated 标签后面的文本串

  使用 @deprecated 标签,来告知用户那些不再被使用的元素。

@deprecated 应用示例:

@copyright

@copyright 可以应用于任何可以使用版权声明的元素,如全局变量(global variable)、引用(include)、常量(constant)、函数(function)、定义(define)、类(class)、变量(variable)、方法(method)、页面(page)。phpDocumentor 将会直接显示 @copyright 后台定义的文本串。

v1.2 新特性:@copyright 属性可以从父类直接遗传到子类,详情请参考 inline {inheritdoc}

@copyright 应用示例:

@category

  @category 标签用户将多个包(packages)组织归类。这里定义的分类可以被 XML:DocBook/peardoc2 转换器直接调用,且可以被其它转换器使用。其它使用 phpDocumentor 打包的转换器会忽略这个分类,但这一情况在将来的版本里可能会有所改变。

  在命令行下,可以使用 -dc, --defaultcategoryname 选项动态地指定分类

@category 应用示例:

@author

  @author 标签可以应用于一些可拥有“作者”属性的元素,如全局变量(global variable)、引用(include)、常量(constant)、函数(function)、定义(define)、类(class)、变量(variable)、方法(method)、页面(page)。phpDocumentor 还会尝试解析尖括号中的文本,如果解析成email成功,则会在生成的文档中生成一个 mailto 链接。

  v1.2 新特性:@author 属性可以从父类直接遗传到子类,详情请参考 inline {inheritdoc}

@access

@access 控制 phpDocumentor 对元素的文档化操作

如果 @access 被设置为 private,只有在命令行下使用 --parseprivate 参数时才会对应用此标签属性的元素进行文档化

@abstract

abstract 有“抽象”的意思,使用 @abstract 声明函数或者类(class),或者是必须经由子类重写才有效的抽象类

@abstract 标签只在有 abstract 关键词的 PHP4 和 PHP5 中有效

代码示例