JavaScript 文档注释

常用注解

• @description

• @file

• @author

• @copyright

• @license

• @version

• @since

• @see

• @todo

• @function

• @type

• @param

• @callback

• @return

• @example

• @class

• @namespace

各个类型传参注释

1. 基本数据类型参数

/**
 * 
 * @param {number} n 数字类型
 * @param {string} str 字符串类型
 * @param {boolean} flag boolean类型
 */
function fun(n,str,flag){

}

2. 对象参数

/**
 * 
 * @param {number} n 数字类型
 * @param {string} str 字符串类型
 * @param {boolean} flag boolean类型
 */
function fun(n,str,flag){

}

3. 数组参数

/**
 * 
 * @param {number} n 数字类型
 * @param {string} str 字符串类型
 * @param {boolean} flag boolean类型
 */
function fun(n,str,flag){

}

4. 方法参数

/**
 * 
 * @param {Function} func 表示一个函数
 */
function fun(func){

}

/**
 * 
 * @param callback 表示一个回调函数
 */
const myArrayFunction = (callback) =>{
    // 函数体
}

5. Rest参数

/**
 * @param {...number} nums - 表示多个数字
 */
function fun(...nums) {
    // 函数体
}

指定默认值

指定多种类型

/**
 * 执行某个操作，接受一个参数，可以是字符串或数字类型
 * @param {string|number} value - 可以是字符串或者数字
 */
function performOperation(value) {
    // 函数体
}

可为空值

/**
 * 执行某个操作，接受一个数字作为参数
 * @param {number} [num] - 可传空值
 */
function fun(num) {
    // 函数体
}

指定默认值

注意：js文档只是提供辅助，需要形参设置默认值才能够生效

/**
 * 执行某个操作，接受一个数字作为参数
 * @param {number} [num=10] - 一个数字，默认值为 10
 */
function performOperation(num = 10) {
    // 函数体
}

指定枚举值

/**
 * 执行某个操作，接受一个枚举类型作为参数
 * @param {'red'|'green'|'blue'} color - 可以是 'red', 'green' 或 'blue'
 */
function performOperation(color) {
    // 函数体
}