Web前端VS Code函数添加文档注释

【添加文档注释】

为函数添加文档注释 为参数的数据类型、参数含义、及函数返回值等进行注释说明，当在其他地方调用该函数时或别人使用该函数时，可以清楚的看到你的注释内容，更好的使用该函数

/**
 *
 * @param {number} num1 参数1说明：数字1
 * @param {number} num2 参数2说明：数字2
 * @returns 返回值说明：计算相加的和
 */
function sum(num1, num2) {
  return num1 + num2;
}

sum();

【文档注释及实用效果——动图演示】

文档注释动图演示