·您当前的位置:主页 > 技术教程 > PHP教程 >

[php]php的DOC类型注释用法详细说明文档

时间:2016-12-30 10:40来源:酷播  极酷网页播放器
[php]php的DOC类型注释用法详细说明文档

[php]php的DOC类型注释用法详细说明文档

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