首页 > 代码库 > PHPDocumentor代码注释规范说明

PHPDocumentor代码注释规范说明

2024-07-17 23:32:03   225人阅读

   PHPDocumentor是一个的用PHP写的道具，对于有规则注释的php程序，它能够快速生成具有相互参照,索引等功能的API文档。

标记用途描述
@abstract 抽象类的变量和方法
@accesspublic, private or protected文档的访问、使用权限. @access private 表明这个文档是被保护的。
@author张三 <zhangsan@163.com>文档作者
@copyright名称 时间文档版权信息
@deprecatedversion文档中被废除的方法
@deprec 同 @deprecated
@example/path/to/example文档的外部保存的示例文件的位置。
@exception 文档中方法抛出的异常，也可参照 @throws.
@global类型：$globalvarname文档中的全局变量及有关的方法和函数
@ignore 忽略文档中指定的关键字
@internal 开发团队内部信息
@linkURL类似于license 但还可以通过link找到文档中的更多个详细的信息
@name变量别名为某个变量指定别名
@magic phpdoc.de compatibility
@package封装包的名称一组相关类、函数封装的包名称
@param如 [$username] 用户名变量含义注释
@return如 返回bool函数返回结果描述，一般不用在void（空返回结果的）的函数中
@see如 Class Login（）文件关联的任何元素（全局变量，包括，页面，类，函数，定义，方法，变量）。
@sinceversion记录什么时候对文档的哪些部分进行了更改
@static 记录静态类、方法
@staticvar 在类、函数中使用的静态变量
@subpackage 子版本
@throws 某一方法抛出的异常
@todo 表示文件未完成或者要完善的地方
@vartype文档中的变量及其类型
@version 文档、类、函数的版本信息


联系
我们