PHP 注释标记
@access
使用范围classfunctionvardefinemodule
该标记用于指明关键字的存取权限privatepublic或proteced
@author
指明作者
@copyright
使用范围classfunctionvardefinemoduleuse
指明版权信息
@deprecated
使用范围classfunctionvardefinemoduleconstentglobalinclude
指明不用或者废弃的关键字
@example
该标记用于解析一段文件内容并将他们高亮显示Phpdoc会试图从该标记给的文件路径中读取文件内容
@const
使用范围define
用来指明php中define的常量
@final
使用范围classfunctionvar
指明关键字是一个最终的类方法属性禁止派生修改
@filesource
和example类似只不过该标记将直接读取当前解析的php文件的内容并显示
@global
指明在此函数中引用的全局变量
@ingore
用于在文档中忽略指定的关键字
@license
相当于html标签中的<a>首先是URL接着是要显示的内容
例如<a href=”百度</a>
可以写作 @license 百度
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名
@package
使用范围页面级别的> definefunctioninclude
类级别的>classvarmethods
用于逻辑上将一个或几个关键字分到一组
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常极其发生的情况
普通的文档标记标记必须在每行的开头以@标记除此之外还有一种标记叫做inline tag用{@}表示具体包括以下几种
{@link}
用法同@link
{@source}
显示一段函数或方法的内容
注释规范
a注释必须是
/**
* 注释内容
*/
的形式
b对于引用了全局变量的函数必须使用glboal标记
c对于变量必须用var标记其类型（intstringbool…）
d函数必须通过param和return标记指明其参数和返回值
e对于出现两次或两次以上的关键字要通过ingore忽略掉多余的只保留一个即可
f调用了其他函数或类的地方要使用link或其他标记链接到相应的部分便于文档的阅读
g必要的地方使用非文档性注释提高代码易读性
h描述性内容尽量简明扼要尽可能使用短语而非句子
i全局变量静态变量和常量必须用相应标记说明
