代码中的注释可以很好的解释当前代码的用途以及逻辑,这样在以后的维护中是非常的方便的。当然在注释中也有一些注释标签的存在,灵活的运用这些注释的标签可以让代码样式或逻辑看起来更加的整洁!

php中常用到的注释标签

@param

用于函数和方法注释里标记

格式:@param [Type] [name] []\

@param string title 文章标题

@return

函数或方法的返回值

格式:@return [类型] [<描述>]]

@return array 结果数组

@deprecated

已过期,或将要被删除,不建议使用的

格式:@deprecated [<版本号>] [<描述>]\

例如

@deprecated 1.0.0 新版本将不再包含此函数\

@link

可用于辅助说明、引用文档的地址

格式:@link [url] [<描述>]\

例如

@link http://g.cn 不懂滚去问谷歌,别来烦我

@var

变量

格式:@var [类型] [变量名] [<描述>]\

@var int id 用户id

@throws

可能会抛出的错误

格式:@throws [类型] [<描述>]\

@throws Exception

@author

文章或代码的作者

例:

@author 墨初

@version

代码或文档类的版本

@version v1.1.2

@todo

表示文档未完成或将要完成

@static

静态类

@copyright

文档或代码的版权信息

@copyright 墨初 2021/01/01 20:08:13

@name

为某个变量指定别名

@name 变量别名