PHP注释规范

转载 2012年03月31日 10:38:54
@access
使用范围:class,function,var,define,module
该标记用于指明关键字的存取权限:private、public或proteced
@author
指明作者
@copyright
使用范围:class,function,var,define,module,use
指明版权信息
@deprecated
使用范围:class,function,var,define,module,constent,global,include
指明不用或者废弃的关键字
@example
该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容
@const
使用范围:define
用来指明php中define的常量
@final
使用范围:class,function,var
指明关键字是一个最终的类、方法、属性,禁止派生、修改。
@filesource
和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。
@global
指明在此函数中引用的全局变量
@ingore
用于在文档中忽略指定的关键字
@license
相当于html标签中的<a>,首先是URL,接着是要显示的内容
例如<a href=”http://www.baidu.com”>百度</a>
可以写作 @license http://www.baidu.com 百度
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名。
@package
使用范围:页面级别的-> define,function,include
类级别的->class,var,methods
用于逻辑上将一个或几个关键字分到一组。
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的。
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常,极其发生的情况
上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:
{@link}
用法同@link
{@source}

显示一段函数或方法的内容

原文地址:http://blog.csdn.net/painsonline/article/details/7414301

Doxygen的安装与配置及简单注释规范

最近接触了一款程序 文档生成工具-Doxygen。在网上一搜索原来这么多人知道,打算把它的使用做一个总结,以及其注释的规则。 概述:  Doxygen是一种开源跨平台的,以类似JavaDoc风格描述...
  • Andy_93
  • Andy_93
  • 2016年11月11日 09:12
  • 3033

java编程规范之java注释规范

代码要是没有注释,对读者来说就是一堆乱七八糟的字母,为了提高代码的可读性和可维护性,必须对代码进行必要的注释,这里小编整理了一下java注释规范。 (一)技巧    1:注释当前行快捷方式:ctr...
  • u012116457
  • u012116457
  • 2014年03月30日 17:47
  • 4168

C++标准注释原则 - 基于doxygen的C++注释

标注总述 下载国外的源代码,往往能看到附带的说明文档,文档都有详细的说明,大部分文档都可以通过doxygen这个跨平台软件生成,doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成...
  • czyt1988
  • czyt1988
  • 2013年05月08日 21:30
  • 11138

PHP Document 代码注释规范

  • 2011年12月22日 12:34
  • 9KB
  • 下载

PHP文件注释标记及规范小结

PHP文件注释标记及规范小结,php开发的朋友可以收藏下,方便以后使用,让我们的代码更专业 PHP 注释标记  @access  使用范围:class,f...
  • w786572258
  • w786572258
  • 2014年11月13日 22:47
  • 225

PHP Document 代码注释规范

PHPDocumentor 是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc,从1.3.0开始,更名为phpDocume...
  • ps6c749qk2
  • ps6c749qk2
  • 2014年05月05日 23:11
  • 231

PHP Document 代码注释规范

PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc。 1. 什么是phpDocumentor ...
  • qiangtonglu
  • qiangtonglu
  • 2012年08月15日 10:14
  • 245

PHP代码注释规范

PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc。1. 什么是phpDocumentor ? ...
  • intersting
  • intersting
  • 2017年03月09日 23:13
  • 107

PHP代码规范注释

@access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private、public或proteced @author 指明作者 @...
  • qq_34437587
  • qq_34437587
  • 2017年05月14日 18:56
  • 82

PHP注释规范

@access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private、public或proteced @author 指明...
  • PainsOnline
  • PainsOnline
  • 2012年03月31日 09:41
  • 723
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:PHP注释规范
举报原因:
原因补充:

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