前言
注释标签在代码注释中的作用非常大，好的找注释标签可以让你在编程过程中有更好、更舒适的体验，所以我今天准备整理一下这些标记，通过图文的形式展示出来，一方面是为了自己对这些注释标签有一个汇总整理，另一方面也希望大家能够更好对理解注释标签
每个人都希望写出漂亮的代码，或许你离漂亮的代码，就差一个标签
常用标签
上面这么多其实很大一部分都是创建文件、创建类的时候需要添加的。今天主要讲解一下常用的标签。
@param
说明
参数，用于函数和方法注释里的标记\\
格式@param [Type] [name] [<description>]\\
例如@param string title 文章标题
代码举例
@return
说明
返回值
格式@return [类型] [<描述>]]
例如@return array 结果数组
代码举例
@deprecated
说明
不建议使用的、已过期的、将被删除的\\
格式@deprecated [<版本号>] [<描述>]\\
例如@deprecated 1.0.0 新版本将不再包含此函数\\
如果它是被其他方法所取代了，建议添加@see标记
代码举例
@see
说明
参考，类似@link，可与@deprecated联动
格式@see [url或完整方法名] [<描述>]
例如@see \\yii\\base\\db::tableName() 旧方法table_name已弃用，请使用此方法替代
代码举例
@link
说明
链接，可用于辅助说明、引用文档等\\
格式@link [url] [<描述>]\\
例如@link http://g.cn 不懂滚去问谷歌，别来烦我
代码举例
@link&@see区别
@var
说明
变量\\
格式@var [类型] [变量名] [<描述>]\\
例如@var int id 用户id
变量列表
代码举例
1、在方法外的变量定义
2、在方法内的变量定义
@throws
说明
可能会抛出的错误类型\\
格式@throws [类型] [<描述>]\\
例如@throws Exception
关于PHPer都应当掌握的注释标记！的文章就分享到这，如果对你有帮助欢迎继续关注我们哦
本文来自投稿，不代表重蔚自留地立场，如若转载，请注明出处https://www.cwhello.com/42134.html
如有侵犯您的合法权益请发邮件951076433@qq.com联系删除
