PHPer都应当掌握的注释标记！前言常用标签@param@return@deprecated@see@link@link&@see区别@var变量列表@throws【PHP教程】

概述PHPer都应当掌握的注释标记！前言常用标签@param@return@deprecated@see@link@link&@see区别@var变量列表@throws

推荐：《PHP视频教程》

前言

注释标签在代码注释中的作用非常大，好的找注释标签可以让你在编程过程中有更好、更舒适的体验，所以我今天准备整理一下这些标记，通过图文的形式展示出来，一方面是为了自己对这些注释标签有一个汇总整理，另一方面也希望大家能够更好对理解注释标签

每个人都希望写出漂亮的代码，或许你离漂亮的代码，就差一个标签

常用标签

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

@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都应当掌握的注释标记！前言常用标签@param@return@deprecated@see@link@link&@see区别@var变量列表@throws全部内容，希望文章能够帮你解决PHPer都应当掌握的注释标记！前言常用标签@param@return@deprecated@see@link@link&@see区别@var变量列表@throws所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。