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

quietin 发布于2019-07-01 14:03 / 848人阅读

摘要：简介注释标签在代码注释中的作用非常大，但是可能很多同学在平常开发中会忽略这些标签的作用，所以我这边特地整理一些常用的注释标记，通过图文展现形式，希望能帮助你能更好理解每个注释标签的作用或许你离漂亮的代码，就差一个标签项目工程地址被此标记的

简介

注释标签在代码注释中的作用非常大，但是可能很多同学在平常开发中会忽略这些标签的作用，所以我这边特地整理一些常用的注释标记，通过图文展现形式，希望能帮助你能更好理解每个注释标签的作用.

或许你离漂亮的代码，就差一个标签^_^

项目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php

@deprecated

@deprecated : 被此标记的函数或者成员方法表示下个版本将会被废弃，告知适用方不再推荐使用此方法.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/deprecated

语法

@deprecated [] []

描述

@deprecated可以填写一个版本号，版本号的规则同@version

如果被标记的方法只是因为被其他新方法代替而被废弃，可以结合@see来表示被代替的方法

标签效果

@inheritdoc

@inheritdoc : 文档继承,会继承父类的文档注释.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc

语法

@inheritDoc

描述

@inheritDoc会继承父类的所有文档注释.在继承之后可以对指定字段进行重写

标签效果 1.直接继承

2.继承重写

@internal

@internal : 被此标签标记的内部类/方法，作用范围只能限于当前文件，外部文件不可调用.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/internal

语法

@internal [description]

使用场景

此标签通常可使用在单元测试中，比如在单元测试中定义了一个测试用的类，可对此测试类添加@internal标签，这样别人在正常逻辑中万一不小心错误引用了测试类，在IDE的帮助下，可以第一时间得到反馈.

标签效果

@link

@link : 此标签可以引导你到指定的外部跳转链接.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/link

语法

@link [URI] []

描述

该标签只有1个跳转选项

@外部跳转链接 : 必须是满足RFC2396的跳转链接,例如http://github.com/yinggaozhen

和@see的区别

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

@see

@see : 此标签可以引导你到指定的外部跳转链接/内部程序.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/see

语法

@see [URI | FQSEN] []

描述

该标签可以有两个跳转选项

@外部跳转链接 : 必须是满足RFC2396的跳转链接,例如http://github.com/yinggaozhen

@内部程序链接 : 可以跳转到制定的类/方法/变量，如class::method

和@link的区别

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

@var

@var : 定义一个数据的类型.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/var

语法

@var [Type] [$element_name] []

变量列表

变量类型	说明
string	字符串
integer/int	number/int类型
boolean/bool	false/true
float/double	number/浮点数
object	对象实例
specifiedType	指定类
mixed	任意类型
array/specifiedType[]	数组，可以指定成指定类型的数组
resource	文件资源类型
void	无返回值
null	-
callable	可执行的回调函数
function	不一定能执行的方法
self/$this	当前实例

标签效果

实现@var可以有两种使用方法

1.在类成员变量中定义，不需要指定变量名称

2.直接给具体变量定义，需要指定变量名称

@throws

@throws : 抛出一个异常，告诉调用方需要做好处理异常相关工作.

详细代码演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/throws

语法

@throws [Type] []

标签效果

最后

文章篇幅有限，这里列举了一部分标签，更多标签可以通过以下工程地址

项目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php

标签会不定期持续更新，欢迎各位star & fork

您的支持是我更新的最大动力~~

云服务器 GPU云服务器每个域名都要备案吗每个云服务器都需要备案每个虚拟主机都需要备案么每个国家的域名后缀

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/31775.html

每一位JSer都应当掌握的注释标记

摘要：表示该函数接受可变数量的参数，并指定一个类型的参数一个可选参数可选参数，默认值指示参数是可选的。一个注释块中您可以包含多个标签。简介注释标签在代码注释中的作用非常大，但是可能很多同学在平常开发中会忽略这些标签的作用，所以我这边特地整理一些常用的注释标记，通过图文展现形式，希望能帮助你能更好理解每个注释标签的作用. 想必掌握这些注释标签之后，不光对您今后的自己代码编写，还是阅读优秀源...

Salamander 2019-08-23 18:17 评论0 收藏0
通用 CSS 笔记、建议与指导

摘要：如下区块标题前缀可以让我们使用命令查找标题名时将搜索范围限制在区块标题中。在参与规模庞大、历时漫长且参与人数众多的项目时，所有开发者遵守如下规则极为重要：保持 CSS 易于维护保持代码清晰易懂保持 CSS 的可拓展性为了实现这一目标，我们要采用诸多方法。本文档第一部分将探讨语法、格式以及分析 CSS 结构；第二部分将围绕方法论、思维框架以及编写与规划 CSS 的看法...

lushan 2019-08-28 17:58 评论0 收藏0
Conflux & TokenGazer AMA活动内容回顾

摘要：安全性不可更改性排序结果不能被坏人的攻击更改。这也是很严重的公链安全事故。总而言之，通过设计安全的拓扑排序算法，解决交易顺序问题。区块排序的一致可以保证无效交易标记的一致。枢轴链和分叉链的区块奖励计算规则是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...

littlelightss 2019-06-25 19:02 评论0 收藏0
Conflux & TokenGazer AMA活动内容回顾

摘要：安全性不可更改性排序结果不能被坏人的攻击更改。这也是很严重的公链安全事故。总而言之，通过设计安全的拓扑排序算法，解决交易顺序问题。区块排序的一致可以保证无效交易标记的一致。枢轴链和分叉链的区块奖励计算规则是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...

DesGemini 2019-06-24 18:17 评论0 收藏0