注释标记说明

@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

阿里云-推广AD
  • 指明一个函数的参数

@return

  • 指明一个方法或函数的返回指

@static

  • 指明关建字是静态的。

@var

  • 指明变量类型

@version

  • 指明版本信息

@todo

  • 指明应该改进或没有实现的地方

@throws

  • 指明此函数可能抛出的错误异常,极其发生的情况
  • 普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:

{@link}

  • 用法同@link

{@source}

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

注释规范

文件头部模板

  1. /**
  2. *这是一个什么文件
  3. *
  4. *此文件程序用来做什么的(详细说明,可选。)。
  5. * @author      richard<e421083458@163.com>
  6. * @version     $Id$
  7. * @since        1.0
  8. */

函数头部注释

  1. /**
  2. * some_func
  3. * 函数的含义说明
  4. *
  5. * @access public
  6. * @param mixed $arg1 参数一的说明
  7. * @param mixed $arg2 参数二的说明
  8. * @param mixed $mixed 这是一个混合类型
  9. * @since 1.0
  10. * @return array
  11. */
  12. public function thisIsFunction($string, $integer, $mixed) {return array();}

类的注释

  1. /**
  2. * 类的介绍
  3. *
  4. * 类的详细介绍(可选。)。
  5. * @author         richard<e421083458@163.com>
  6. * @since          1.0
  7. */
  8. class Test
  9. {
  10. }

程序代码注释

1. 注释的原则是将问题解释清楚,并不是越多越好。

2. 若干语句作为一个逻辑代码块,这个块的注释可以使用/* */方式。

3. 具体到某一个语句的注释,可以使用行尾注释://。

  1. /* 生成配置文件、数据文件。*/
  2. $this->setConfig();
  3. $this->createConfigFile();  //创建配置文件
  4. $this->clearCache();         // 清除缓存文件
  5. $this->createDataFiles();   // 生成数据文件
  6. $this->prepareProxys();
  7. $this->restart();