JS函数注释规范及IDE配置

JS函数注释规范

描述函数作用与功能

格式：@description descriptionStatements

/**
 * @description 描述函数的作用或功能
 */

描述参数

格式：@param {参数数据类型} 参数 参数描述

参数	说明
p	必选参数
[p]	可选参数
[p='xxx']	带默认值的参数

/**
 * @param { string } a 参数描述
 * @param { number } [b] 参数描述
 * @param { boolean } [c=false] 参数描述
 */

描述为数组的参数

/**
 * 数组参数：
 * @param { array } arr 参数描述
 * @param { string } arr[0] 参数描述
 * @param { number } [arr[1]=undefined] 参数描述
 */

描述返回值

格式为@return { 返回值类型 } 描述语句

TIP

即使无返回值，也要写@return { undefined }

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

完整示例

/**
 * @description 描述fn的作用或功能
 * @param { string } a 参数描述
 * @param { number } [b] 参数描述
 * @param { boolean } [c=false] 参数描述
 *
 * @return { number } 描述返回值
 */
function fn(a, b, c = false) {
  // code
  return 1;
}

文档注释IDE配置

vscode

建议直接安装插件document this