怎样写phpdocumentor注释

       所有的文档性注释都是由/**开始的一个的多行注释，在phpDocumentor里称为DocBlock, DocBlock是指软件 开发编写的涉及某个KEYexpress的帮助消息，使得更多相关人能够经过它明白那个KEYexpress的具体用途，如何应用。 PhpDocumentor规定一个的DocBlock包含如下消息：
1. 功能简述区
2. 详细说明区
3. 标识tag
文 档性注释的第一行是功能描述区，正文一般是简明扼要地说明那个类，窍门或者的功能，功能简述的正文在生成的文档中将显示在索引区。功能描述区的内容没成绩 经过一个的空行或者 . 来结束
在功能描述区后是一个的空行，接着是详细说明区,. 这部份主要是详细说明你的API的功能，用途，假如估计，也没成绩有应用举例等等。在这部份，你应该着重阐明你的API参数或者窍门的通常的用途，应用， 并且指明也许是跨平台的（假如涉及到），对于和平台有关的消息，你要和那些通用的消息区别对待，通常的做法是另起一行，然后写出在某个特定平台上的留意事 项或者是特别的消息，这一些消息应该足够，以便你的读者能够编写相应的测试消息，比如边界要求，参数范围，断点等等。
之后同样是一个的空白行，然 后是文档的标识tag，指明一些上的消息，主要是最主要的是调用参数类别，返回value极其类别，继承联系，有关窍门/参数等等。
涉及文档标 识，详细的请参考第四节:文档标识。
文档注释中还没成绩应用例如<b> <co

de>那样的标签，详细介绍请 参考附录二。
下面是一个的文档注释的例子

/**
* 参数add,出现两个数的加法
*
* 一个的简单的加法计算，参数接受两个数a、b，返回她们的和c
*
* @param int 加数
* @param int 被加数
* @rechanging integer
*/
function Add($a, $b) {
rechanging $a+$b;
}

生成文档如下：
Add
integer Add( int $a, int $b)
[line 45]
参数add,出现两个数的加法
Constants 一个的简单的加法计算，参数接受两个数a、b，返回她们的和c
Parameters
? int $a - 加数
? int $b - 被加数

            文档标识的应用范围是指该标识没成绩用来修饰的KEYexpress，或更多相关文档标识。
所有的文档标识都是在每一行的 * 后面以@开头。假如在一段话的中间出来@的标识，那个标识将会被当做普通内容而被忽略掉。
@
应用范 围：class,function,var,define,module
该标识用于指明KEYexpress的存取权限：private、 public或proteced
@author
指明作者
@copyright
应用范 围：class，function，var，define，module，use
指明版权消息
@deprecated
应用范 围：class，function，var，define，module，constent，global，include
指明不用或者废弃的 KEYexpress
@for instance
该标识用于解析一段文档内容，并将她们高亮显示。Phpdoc会试图从该标识给的文档路 径中读取文档内容
@const
应用范围：define
用来指明php中define的常量
@final
应用范 围：class,function,var
指明KEYexpress是一个的最终的类、窍门、属性，禁止派生、改正。
@filesource
和for instance类似，只不过该标识将直接读取当前解析的php文档的内容并显示。
@global
指明在此参数中引用的全局变量
@ingore
用 于在文档中忽略指定的KEYexpress
@license
相当于静态网页标签中的<a>,首先是URL，接着是要显示的内 容
例如<a href=”http://www.baidu.com”>百度</a>
没成绩书面表达 @license http://www.baidu.com 百度
@link
类似于license
但还没成绩经过link指到 文档中的任何一个的KEYexpress
@title
为KEYexpress指定一个的别名。
@package
应用范 围：页面级别的-> define，function，include
类级别的->class，var，methods
用于 逻辑上将一个的或几个KEYexpress分到一组。
@abstrcut
说明当前类是一个的抽象类
@param
指明一个 的参数的参数
@rechanging
指明一个的窍门或参数的返回指
@static
指明关建字是静态的。
@var
指 明变量类别
@version
指明版本消息
@todo
指明应该改进或没有出现的地方
@throws
指明此 参数估计抛出的错误异常,极其除了的情况
上面提到过，普通的文档标识标识必需在每行的开头以@标识，除此之外，还有一种标识叫做inline tag,用{@}表明，具体包括以下几种：
{@link}
应用同@link
{@source}
显示一段参数或窍门的内容