博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

phpdoc 注释关键字含义

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