JSDoc注释规范是什么

　　介绍

小编给大家分享一注下JSDoc释规范是什么,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获、下面让我们一起去了解一下吧!

<强>什么是JSDoc

JSDoc是一个根据JavaScript文件中注释信息,生成JavaScript应用程序或模块的API文档的工具。你可以使用JSDoc标记如:命名空间,类,方法,方法参数等,从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护成本,和提高开发效率。

<强> JSDoc注释规则

JSDoc注释一般应该放置在方法或函数声明之前,它必须以/* *开始,以便由JSDoc解析器识别。其他任何以,/*,,,/* * *,或者超过3个星号的注释,都将被JSDoc解析器忽略。如下所示:

/* 　　注* *一段简单的JSDoc释。 　　*/的

<强> JSDoc注释效果

假如我们有一段这样的代码,没有任何注释,看起来是不是有一定的成本。

functionBook(标题、作者){ 　　this.title=标题; 　　this.author=作者; 　　} 　　Book.prototype={ 　　getTitle:函数(){ 　　returnthis.title; 　　}， 　　setPageNum:函数(pageNum) { 　　this.pageNum=pageNum; 　　} 　　};

如果使用了JSDoc注释该代码后,代码的可阅读性就大大的提高了。

/* * 　　*书类,代表一个书本。 　　* @constructor 　　* @param{}字符串标题——书本的标题。 　　* @param{字符串}-书作者本的作者。 　　*/functionBook(标题、作者){ 　　this.title=标题; 　　this.author=作者; 　　} 　　Book.prototype={/* * 　　*获取书本的标题 　　* @returns{字符串| *}返回当前的书本名称 　　*/getTitle:函数(){ 　　returnthis.title; 　　}，/* * 　　*设置书本的页数 　　* @param pageNum{}数页数 　　*/setPageNum:函数(pageNum) { 　　this.pageNum=pageNum; 　　} 　　};

<>强@constructor构造函数声明注释

@constructor明确一个函数是某个类的构造函数。

<强> @param参数注释

我们通常会使用@param来表示函数、类的方法的参数,@param是JSDoc中最常用的注释标签。参数标签可表示一个参数的参数名,参数类型和参数描述的注释。如下所示:

/* * 　　* @param{字符串}措辞需要说的句子 　　*/functionsay(措辞){ 　　console.log(字样); 　　}

<>强@return返回值注释

@return表示一个函数的返回值,如果函数没有显示指定返回值可不写。如下所示:

/* 　　* @return{号码}返回值描述 　　*/

<>强@example示例注释

@example通常用于表示示例代码,通常示例的代码会另起一行编写,如下所示:

/* 　　* @example 　　*乘以(3 2); 　　*/

<>强其他常用注释

@overview对当前代码文件的描述。

@copyright代码的版权信息。

@author,[]代码的作者信息。

@version当前代码的版本。

以上是“JSDoc注释规范是什么”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注行业资讯频道!

JSDoc注释规范是什么