当前位置: 首页 > 后端技术 > Node.js

每一个JSer都应该掌握的注释标签

时间:2023-04-03 22:40:18 Node.js

介绍注释标签在代码注释中起着非常重要的作用,但是很多同学在平时开发中可能会忽略这些标签的作用,所以我在这里特地整理了一些常用的注释标记,形式如下的图文介绍,希望能帮助大家更好的理解各个评论标签的作用。想必,掌握了这些注释标签后,不仅对你以后写自己的代码有帮助,还能阅读优秀的源码。也许你离美丽的代码只差一个tag^_^项目地址:https://github.com/yinggaozhen/doc-demo/tree/master/javascriptEgg源码包含大量评论标签常用标签@abstract@abstract:used该标签标识的成员方法必须在继承该成员的对象中实现。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/abstract推荐使用PhpStorm/WebStorm读取该标签,可以直观的体现标签的功能。别名:@virtual概括了该成员(一般指父类的方法)必须在继承的子类中实现(或重写)。语法@abstract标记作用@constructor@constructor:constructor标记的方法将被视为一个构造函数。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/constructor这个标签推荐使用PhpStorm/WebStorm阅读,可以直观的体现标签语法@class[]alias@classlabeleffect@deprecated@deprecated:以此标记的函数或成员方法,表示下个版本将被弃用,告知适用方不再推荐使用该方法。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/deprecated此标签推荐使用PhpStorm/WebStorm阅读,可能直观体现标签的功能语法@deprecated[]Description如果被标记的方法只是因为被其他新方法替换而被丢弃,可以与@see结合使用,表示被替换方法标签的作用Deprecatedlabelcollocation@see@inheritdoc@inheritdoc:表示该标识符应继承其父类的文档。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/inheritdoc推荐使用PhpStorm/WebStorm读取这个标签,可以直观的体现标签语法的功能@inheritdoc标签作用@member@member:可以为成员变量定义一个类型。您可以选择为成员变量指定一个名称。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/member此标签推荐使用PhpStorm/WebStorm阅读,或许能直观体现标签别名的作用@varsyntax@member[][]typetypetypebasictypetypedescriptionstringstringArrayorType[]arraynumbernumberObjectobjectClass自定义类名Function方法类型null-*anytypetype格式类型名语法示例描述符号名称{boolean}{myNamespace.MyClass}指定符号的名称。如果标识符已经记录在案,JSDoc将为该标识符创建一个指向文档的链接。列表。Arrays{Array.string}或string[]表示字符串数组-Objects{name:string,age:number}或Object-可空类型数字或空{?number}表示类型为指定类型,或空.不可为空的类型一个数字,但它永远不会为空{!number}表示该类型是指定的类型,但它永远不会为空。该类型的可变数量此函数接受可变数量的数字参数。@param{...number}num表示函数接受可变数量的参数并指定参数的类型可选参数可选参数@param{number}[foo]@param{number}[foo=1]可以是可选参数,default=1表示该参数是可选的。当对可选参数使用JSDoc的语法时,您还可以为参数指定一个默认值。标签效果@param@param:标签提供了函数参数的各种描述,包括参数名称、参数数据类型、描述等。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/param推荐使用PhpStorm/WebStorm读取这个标签,可以直观的体现标签的功能语法@param{type}{name}{desc}概述@param标签需要你指定一个描述参数的名称。您还可以包括参数的数据类型(括在大括号中)和参数的描述。类型表达式可以有如下表达式标识符的名称路径(例如myNamespace.MyClass)一个内置的javascript类型(例如字符串,数字)以上两个标签的组合作用函数输入参数定义类型输入参数的函数是一个Object,可以定义入参对象属性类型@see@see:这个标签表示可以参考另一个标识符的文档,或者外部资源。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/see推荐使用PhpStorm/WebStorm读取这个标签,可以直观的体现标签的功能语法@see@see标签效果动画演示内容可以通过@see标记的{Foo#bar}跳转到Foo类中的bar成员属性。点击@seehttp://www.baidu.com标记的外部链接,可以跳转到浏览器查看@throws@throws:表示可能抛出什么样的错误。详细代码demo:https://github.com/yinggaozhen/doc-demo/tree/master/javascript/throws推荐使用PhpStorm/WebStorm读取这个标签,可以直观的体现标签的功能语法@throws自由格式描述@throws{}@throws{}自由格式描述概述@throws标签允许您描述函数可能抛出的错误。您可以在注释块中包含多个@throws标记。示例/***@description抛出指定错误类型的错误*@throws{SQLException}*/functiontagThrows1(){}/***@throwsSQLExecutefailed*/functiontagThrows2(){}/***@throws{SQLException}SQL执行失败。*/functiontagThrows3(){}上一篇文章篇幅有限,这里是一些标签,更多标签可以通过以下项目地址找到项目项目地址:https://github.com/yinggaozhen/doc-Thedemo/tree/master/javascript标签会不时更新。欢迎来到star&fork。你们的支持是我更新最大的动力~~