JavaScript文档注释JSDoc注释

普通多行注释

/**
* 普通的多行注释
*/

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

它必须以/ **开始,以便由JSDoc解析器识别。其他任何以 /* , /*** 或者超过3个星号的注释,都将被JSDoc解析器忽略。

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

/**
* @param {String} wording 需要说的句子
*/
function qiao(wording){
    console.log(wording);
}

@return 返回值注释

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

/*
* @return {Number} 返回值描述
*/

@example 示例注释

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

/*
* @example
* multiply(3, 2);
*/

@author 代码的作者信息

@author标识项目的作者。在jsdoc3.2和更高版本中,如果作者的名字后面跟一个用尖括号括起来的电子邮件地址,默认模板会将电子邮件地址转换为mailto:链接。

/**
 * @author Jane Smith <change@change.com>
 */
function MyClass() {}

@version当前代码的版本

记录项的版本。@version标记后面的文本将用于表示项的版本。

/**
 * Solves equations of the form a * x = b. Returns the value
 * of x.
 * @version 1.2.3
 * @tutorial solver
 */
function solver(a, b) {
    return b / a;
}

@file对当前代码文件的描述

@file标记提供文件的描述。在文件开头的JSDoc注释中使用标记。

/**
 * @file Manages the configuration settings for the widget.
 * @author Rowina Sanela 
 */

@copyright代码的版权信息

@copyright标记用于在文件概述注释中记录版权信息。将此标记与@file标记结合使用。

/**
 * @file 描述
 * @copyright 名字时间
 */

  • 2
    点赞
  • 19
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值