强制折叠写法// #region 两头这里是要被正文的内容 // #endregion // #region // Lorem ipsum dolor sit amet consectetur adipisicing elit. Recusandae, similique mollitia. // Lorem ipsum dolor sit amet consectetur adipisicing elit. Mollitia. // ing elit. Recusandae, similiqu // m dolor sit amet consectetur adipisicing elit. Molliti // #endregion
简介注释标签在代码注释中的作用非常大，但是可能很多同学在平常开发中会忽略这些标签的作用，所以我这边特地整理一些常用的注释标记，通过图文展现形式，希望能帮助你能更好理解每个注释标签的作用. 或许你离漂亮的代码，就差一个标签^_^ 项目工程地址 : 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外部链接√√内部程序√X _ @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外部链接√√内部程序√X _ @var@var : 定义一个数据的类型. ...