phpdoc @注释内容

原创 2007年09月19日 09:28:00
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定义版本信息

phpdoc/phpdocumentor注释规范

phpDocumentor通过解析PHP代码逻辑结构(如文件,类,函数,常量,全局变量,类成员/方法等),重新整理后生成普通的可读说明文档。一、给php代码添加规范的注释 PHPDocument是从...
  • cjqh_hao
  • cjqh_hao
  • 2015年11月22日 00:51
  • 2273

【小结】PHP之文档注释规范PHPDoc

良好的文档注释不但能使代码易于维护,而且可以通过phpDocumentor等文档生成工具生成项目手册,以便于查阅。此外PHP的弱类型特征更应该引起我们对文档注释的重视! 本文简单的介绍下PHPDoc...
  • Eric6
  • Eric6
  • 2010年09月16日 17:08
  • 6714

PHP经验——PHPDoc PHP注释的标准文档(翻译自Wiki)

文档注释,无非“//”和“/**/”两种 ,自己写代码,就那么点,适当写几句就好了;但是一个人总有融入团队的一天,团队的交流不是那几句注释和一张嘴能解决的,还需要通用的注释标准。 PHPDoc是PH...
  • haozi3156666
  • haozi3156666
  • 2014年06月19日 13:35
  • 599

phpdoc @注释内容

以下的不全@abstract 申明变量/类/方法@access指明这个变量、类、函数/方法的存取权限@author 函数作者的名字和邮箱地址@category  组织packages@copyrigh...
  • joliny
  • joliny
  • 2007年09月19日 15:49
  • 528

使用phpdoc/phpDocumentor来生成api文档

使用phpdoc/phpDocumentor来生成api文档
  • wuchengzeng
  • wuchengzeng
  • 2015年04月27日 13:10
  • 4594

phpdoc 注释写法

/** * @name  名字 * @abstract  申明变量/类/方法 * @access  指明这个变量、类、函数/方法的存取权限 * @author  函数作者的名字...
  • wide288
  • wide288
  • 2012年07月12日 16:38
  • 840

如何使用phpdoc生成PHP文档

如何使用phpdoc生成PHP文档
  • rcom10002
  • rcom10002
  • 2010年08月12日 08:53
  • 2778

PHPdoc 注释的关键词

如 @author, @since, @param 等 /** * The short description * * As many lines of extendend descriptio...
  • wide288
  • wide288
  • 2014年03月21日 13:34
  • 551

phpdoc -o 输出文档模版 汇总

*   HTML:frames:* - 输出带框架的HTML页面     *     HTML:frames:default - 类Javadoc模板,没有太多格式     *     HTML:...
  • YoungerChen
  • YoungerChen
  • 2012年09月02日 22:51
  • 2430

PHPDocumentor 注释规范整理

你会写注释么?从我写代码开始,这个问题就一直困扰着我,相信也同样困扰着其他同学。以前的写注释总是没有一套行之有效的标准,给维护和协同开发带了许多麻烦,直到最近读到了phpdocumentor的注释标准...
  • Qlong_dd
  • Qlong_dd
  • 2014年07月31日 23:36
  • 1459
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:phpdoc @注释内容
举报原因:
原因补充:

(最多只允许输入30个字)