文档注释

基础注释
@param {number} [duration] '[]' 表示可选

/**
 * 函数防抖
 * @listens 
 * @param {function} func 目标函数
 * @param {number} [duration] 延迟执行的时间 【[] 表示可选】
 * @return {function} 防抖的函数
 */
function dobounce(func, duration = 100) {
}
dobounce()

示例注释
@exports getRandom (1, 10) // 获取[1,10] 之间的随机数

/**
 * 获取指范围内的随机整数
 * @author 刘远翔 <123@qq.com> 作者 邮箱
 * @param {number} min 随机数的最小值
 * @param {number} max 随机数的最大值
 * @return {number} 随机数 【返回值】
 * @exports 
 * getRandom(1, 10) // 获取[1,10] 之间的随机数  【示例代码】
 */
function getRandom(min,max) {
  
}

对象注释

/**
 * 网络请求
 * @param {object} options 配置对象
 * @param {object} options.url 请求地址
 * @param {'GET'|'POST'} options.method 请求类型
 * @param {object} options.body
 * @param {object} options.headers
 */
async function require(options) {

}

require({
  method: 'GET'
})