PHP

@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 中有效

代码示例

页面