当前位置: 首页 > 后端技术 > PHP

每个PHPer都应该掌握的评论标志

时间:2023-03-29 22:15:03 PHP

简介注解标签在代码标注中起着非常重要的作用,但是很多同学在平时开发中可能会忽略这些标签的作用,所以我在这里特地整理了一些常用的注解标签,并以图文形式展示,希望能帮助大家更好的理解每个注释标签的作用。或许你离美丽的代码还差一个tag^_^项目地址: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来表示被替换方法的效果label_@inheritdoc@inheritdoc:文档继承,将继承父类的文档注释。详细代码演示:https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc语法@inheritDoc说明@inheritDoc会继承父类的所有文档注释。继承后,可以重写指定的字段。标签作用1.直接继承2.继承重写_@internal@internal:被这个标签标记的内部类/方法,作用范围只能限制在当前文件,不能调用外部文件。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/php/internalsyntax@internal[说明]使用场景该标签通常可以在单元测试中使用。比如在单元测试中定义了一个测试类,可以在这个测试类上加上@internal标签,这样其他人在正常逻辑中不小心误引用了这个测试类,借助IDE,您可以在第一时间得到反馈。标签作用_@link@link:这个标签可以引导你到指定的外部跳转链接。详细代码演示:https://github.com/yinggaozhen/doc-demo/tree/master/php/link语法@link[URI][]描述标签只有1个跳转选项@external跳转链接:必须满足RFC2396跳转链接,比如http://github.com/yinggaozhen和@see-@see@link的区别外部链接√√内部程序√X_@see@see:这个标签可以引导你到指定的外部跳转链接/内部程序.详细代码演示:https://github.com/yinggaozhen/doc-demo/tree/master/php/see语法@see[URI|FQSEN][]Description这个标签可以有两次跳转transferoption@externaljumplink:必须是符合RFC2396的跳转链接,比如http://github.com/yinggaozhen@internalprogramlink:可以跳转到一个指定类/方法/变量,如class::method和@link-@see@link的区别外链√√内部程序√X_@var@var:定义一个数据类型。详细代码演示:https://github.com/yinggaozhen/doc-demo/tree/master/php/var语法@var[Type][$element_name][]变量列表变量类型描述stringstringinteger/intnumber/inttypeboolean/boolfalse/truefloat/doublenumber/floatingpointobjectinstancespecifiedTypespecifiedclassmixed任意类型数组/specifiedType[]数组可指定为指定类型数组资源文件资源类型void无返回值可空调用可执行文件回调函数function可能不是executablemethodself/$this当前实例标签效果实现@var有两种使用方式1.在类成员变量中定义,不需要指定变量名2.直接定义具体变量,需要指定变量名_@throws@throws:抛出异常,告诉调用者需要处理异常相关worker为了。详细代码演示:https://github.com/yinggaozhen/doc-demo/tree/master/php/throws语法@throws[Type][]标签效果_上篇文章篇幅有限,这里放一部分标签,更多标签可以通过以下项目地址获取项目项目地址:https://github.com/yinggaozhen/doc-demo/tree/master/php标签会不定时更新,欢迎star&fork支持是我更新最大的动力~~