前言

注释标签在代码注释中的作用非常大，好的寻注释标签可以让你在编程历程中有更好、更舒服的体验，所以我今天预备整理一下这些标志，通过图文的情势展现出来，一方面是为了本人对这些注释标签有一个汇总整理，另一方面也但愿大家能够更好对懂得注释标签

每个人都但愿写出美丽的代码，或许你离美丽的代码，就差一个标签

常用标签

标志	用处	描写
@abstract		抽象类的变量和办法
@access	public, private or protected	文档的拜访、使用权限. @access private 表白这个文档是被庇护的。
@author	张三 zhangsan@163.com	文档作者
@copyright	名称时间	文档版权信息
@deprecated	version	文档中被废止的办法
@deprec		同 @deprecated
@example	/path/to/example	文档的外部留存的示例文件的位置。
@exception		文档中办法抛出的非常，也可参照 @throws.
@global	类型：$globalvarname	文档中的全局变量及有关的办法和函数
@ignore		忽略文档中指定的关键字
@internal		开发团队内部信息
@link	URL	相似于license 但还可以通过link寻到文档中的更多个具体的信息
@name	变量别号	为某个变量指定别号
@magic		phpdoc.de compatibility
@package	封装包的名称	一组相关类、函数封装的包名称
@param	如 $username 会员名	变量含义注释
@return	如返回bool	函数返回结果描写，一样不消在void（空返回结果的）的函数中
@see	如 Class Login()	文件关联的任何元素（全局变量，包罗，页面，类，函数，定义，办法，变量）。
@since	version	记载什么时候对文档的哪些部分停止了更换
@static		记载静态类、办法
@staticvar		在类、函数中使用的静态变量
@subpackage		子版本
@throws		某一办法抛出的非常
@todo		表示文件未完成或者要完美的地方
@var	type	文档中的变量及其类型
@version		文档、类、函数的版本信息

上面这么多其实很大一部分都是创立文件、创立类的时候需要增加的。今天主要讲解一下常用的标签。

参数，用于函数和办法注释里的标志\
格局@param [Type] [name] [<description>]\
例如@param string title 文章标题

每个PHPer都应当掌握的注释标记

返回值
格局@return [类型] [<描写>]]
例如@return array 结果数组

每个PHPer都应当掌握的注释标记

不倡议使用的、已过期的、将被删除的\
格局@deprecated [<版本号>] [<描写>]\
例如@deprecated 1.0.0 新版本将不再包括此函数\
假如它是被其他办法所代替了，倡议增加@see标志

每个PHPer都应当掌握的注释标记

参照，相似@link，可与@deprecated联动
格局@see [url或完全办法名] [<描写>]
例如@see \yii\base\db::tableName() 旧办法table_name已弃用，请使用此办法替换

每个PHPer都应当掌握的注释标记

链接，可用于辅助说明、援用文档等\
格局@link [url] [<描写>]\
例如@link http://g.cn 不懂滚去问谷歌，别来烦我

每个PHPer都应当掌握的注释标记

-	@see	@link
外部链接	√	√
内部程序	√	X

变量\
格局@var [类型] [变量名] [<描写>]\
例如@var int id 会员id