,用途,如果可能,也可以有用法举例等等。在这部分,你应该着重阐明你的API函数或者方法的通常的用途,用法,并且指明是否是跨平台的(如果涉及到),对于和平台相关的信息,你要和那些通用的信息区别对待,通常的做法是另起一行,然后写出在某个特定平台上的注意事项或者是特别的信息,这些信息应该足够,以便你的读者能够编写相应的测试信息,比如边界条件,参数范围,断点等等。 之后同样是一个空白行,然后是文档的标记tag,指明一些技术上的信息,主要是最主要的是调用参数类型,返回值极其类型,继承关系,相关方法/函数等等。 关于文档标记,详细的请参考第四节:文档标记。 文档注释中还可以使用例如<b> <code>这样的标签,详细介绍请参考附录二。 下面是一个文档注释的例子
/** * 函数add,实现两个数的加法 * * 一个简单的加法计算,函数接受两个数a、b,返回他们的和c * * @param int 加数 * @param int 被加数 * @return integer */ function Add($a, $b) { return $a+$b; }
生成文档如下: Add integer Add( int $a, int $b) [line 45] 函数add,实现两个数的加法 Constants 一个简单的加法计算,函数接受两个数a、b,返回他们的和c Parameters • int $a - 加数 • int $b - 被加数 5.文档标记: 文档标记的使用范围是指该标记可以用来修饰的关键字,或其他文档标记。 所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记,这个标记将会被当做普通内容而被忽略掉。 @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} 显示一段函数或方法的内容 6.一些注释规范 a.注释必须是 /** * XXXXXXX */ 的形式 b.对于引用了全局变量的函数,必须使用glboal标记。 c.对于变量,必须用var标记其类型(int,string,bool...) d.函数必须通过param和return标记指明其参数和返回值 e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可 f.调用了其他函数或类的地方,要使用link或其他标记 |