php DOC类型注释的用法

1. /** 
2. * @name 名字 
3. * @abstract 申明变量/类/方法 
4. * @access 指明这个变量、类、函数/方法的存取权限 
5. * @author 函数作者的名字和邮箱地址 
6. * @category  组织packages 
7. * @copyright 指明版权信息 
8. * @const 指明常量 
9. * @deprecate 指明不推荐或者是废弃的信息
10. * @deprec 与deprecate含义相同 
11. * @example 示例 
12. * @exclude 指明当前的注释将不进行分析，不出现在文挡中 
13. * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。 
14. * @global 指明在此函数中引用的全局变量 
15. * @include 指明包含的文件的信息 
16. * @link 定义在线连接 
17. * @module 定义归属的模块信息 
18. * @modulegroup 定义归属的模块组 
19. * @package 定义归属的包的信息
20. * @subpackage 子包 
21. * @param 定义函数或者方法的参数信息 
22. * @return 定义函数或者方法的返回信息 
23. * @see 定义需要参考的函数、变量，并加入相应的超级连接。 
24. * @since 指明该api函数或者方法是从哪个版本开始引入的 
25. * @static 指明变量、类、函数是静态的。 
26. * @throws 指明此函数可能抛出的错误异常,极其发生的情况
27. * @exception 同throws含义 
28. * @todo 指明应该改进或没有实现的地方 
29. * @var 定义说明变量/属性。 
30. * @version 定义版本信息 
31. */  

 

参考：http://zh.wikipedia.org/wiki/PHPDoc

 

1. /**
2.  * @abstract
3.  * @access public
4.  * @author John Doe <john.doe@example.com>
5.  * @category name
6.  * @copyright (c) year, John Doe
7.  * @deprecated since version number
8.  * @example path description
9.  * @global type $variable
10.  * @ignore
11.  * @internal description
12.  * @license http://URL name
13.  * @link URL description
14.  * @name $globalVariableName
15.  * @see elementName
16.  * @since version
17.  * @static
18.  * @todo Description
19.  * @tutorial package
20.  * @uses element Description
21.  * @var type Description
22.  * @version string
23.  */

 

以上为ApiGen的标准语法内容，在开发过程中，同样是可以延用phpDoc的语法内容。