phpdoc @注释内容

来源:互联网 发布:手机相机软件下载 编辑:程序博客网 时间:2024/05/29 17:29
http://manual.phpdoc.org

以下的不全

@abstract 申明变量/类/方法
@access指明这个变量、类、函数/方法的存取权限
@author 函数作者的名字和邮箱地址
@category  组织packages
@copyright指明版权信息
@const指明常量
@deprecate指明不推荐或者是废弃的信息
@example 示例
@exclude指明当前的注释将不进行分析,不出现在文挡中
@final指明这是一个最终的类、方法、属性,禁止派生、修改。
@global指明在此函数中引用的全局变量
@include指明包含的文件的信息
@link定义在线连接
@name名字
@module定义归属的模块信息
@modulegroup定义归属的模块组
@package定义归属的包的信息
@param定义函数或者方法的参数信息
@return定义函数或者方法的返回信息
@see定义需要参考的函数、变量,并加入相应的超级连接。
@since 指明该api函数或者方法是从哪个版本开始引入的
@static 指明变量、类、函数是静态的。
@throws指明此函数可能抛出的错误异常,极其发生的情况
@todo指明应该改进或没有实现的地方
@var定义说明变量/属性。
@version定义版本信息