### phpdoc注释 常见的类型 * [ ] @author Author Name 帮助获得负责某个特定元素的人的信息(强烈推荐使用这一标签) [<author@email.com>] * [ ] @copyright Copyright 可指定代码的版权所有者 * [ ] @deprecated [version 可通知代码的使用者这个元素不再被使用并且已经被替换 * [ ] @example [pathlurl] 可引用一个例子，阐释如何使用这个元素。第二个参数可以是一个路径也可以是 description 一个完整的URL * [ ] @filesource 可用来表示希望让文件源出现在文档中 这一标签只能出现在页面级别的块中，在其他地方出现将会被忽略 * [ ] @global datatype 说明了全局变量的数据类型。这一标签必须紧贴在全局变量的前面，并且只对 description phpDocumentor解析器起作用。对于基于反射技术的解析器用处不大 * [ ] @ignore 通知解析器忽略这个元素，并且不将它包含在文档中 * [ ] @internal 可以隐藏特定的信息，使之不出现在公开文档中。可以用在内嵌的注释内容中或者新行注释中 * [ ] @license url [license] 指定此软件授权信息的URL，还可以说明授权者的姓名 * [ ] @link url [description] 在文档中包含一个链接。这个标签可以用在内嵌的内容中 * [ ] @param datatype 说明与函数和方法关联的参数。这可能是最重要的标签。变量名称参数可以包括， $variablename[...] 符号以表示函数可以传入不定数量的其他参数 * [ ] @return datatype 说明了函数或方法返回的数据类型。这可能是第二个重要的标签，并且它是在PHP description 中包含关于返回数据的元数据的唯一方法。推荐所有具有返回值的函数使用这一标签 * [ ] @see reference 引用另外一个元素的文档。在这里可以使用不同类型的指针，包括文件、函数名称、类方法以及其他许多类型的指针。多个指针值可以用逗号隔开。这个标签也可以用在内嵌的内容中 * [ ] @since version 用于说明这个元素第一次出现的版本信息 * [ ] @source startoffset 用于包括内嵌于文档中的相关联元素的部分源代码内容(这个元素只能用在内嵌 [endoffset] 的内容中)。起始偏移量是希望在文档中包含的起始行号，而终止偏移量是希望包含的行的数量。如果省略终止偏移量，起始偏移量到元素结束位置之间的所有代码都将被包含在内 * [ ] @todo description 包含了待完成工作的信息，或者待解决问题的信息 * [ ] @var datatype 说明了类变量的类型，类变量也被看作是属性 * [ ] @version 指定了元素的当前版本号