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

简介

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

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

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

_

@deprecated

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

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

语法

@deprecated [<version>] [<description>]

描述

@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] [<description>]

描述

该标签只有1个跳转选项

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

和@see的区别

-

@see

@link

@see_

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

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

语法

@see [URI | FQSEN] [<description>]

描述

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

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

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

和@link的区别

-

@see

@link

@var_

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

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

语法

@var [Type] [$element_name] [<description>]

变量列表

变量类型

说明

标签效果

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

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

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

_

@throws

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

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

语法

@throws [Type] [<description>]

标签效果

原文链接:http://www.phpxs.com/post/6295/
如有疑问请与原作者联系

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有