• 一般放在需要解释的代码前面

• 以/**开始 多一个少一个*都不是JSDoc了

• 参考：

  Use JSDoc文档

  JSDoc 注释规范

感觉见最多的就是@param和@example了

@constructor

构造函数声明注释

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

@param

参数注释

同义标签还有@arg @argument 用哪个都行吧应该

可用于表示一个参数的名称、类型和描述

/**
*@param parameterName {type} 这里解释底下的代码有什么用
*/

@return

返回值注释

同义标签还有@returns

用来表示不止一种类型的函数返回值 还可以返回Promise对象

/**
*@return {(number|Array)} 解释一下会返回什么东西 是是什么类型
*/

如果函数没有返回值也可以不写嗷 这东西又不是强制要写的

@example

示例注释

通常是另起一行写一段代码来示例

/**
*@example
*setValue("举个栗子");
*/

其他常用注释

• @overview代码概览 总结一下我写这个东西有什么用
• @copyright代码的版权信息
• @author []代码的作者
• @version代码当前的版本