JSDoc 可选参数 - Javascript

JSDoc 是 Javascript 中常用的代码注释工具，它能够生成文档，帮助程序员更好地管理和使用代码。在 JSDoc 中，可以使用 @param 标签定义函数参数，也可以在 @param 标签后面添加一个 [可选] 标记来定义可选的参数。

定义可选参数

在 JSDoc 中，使用 [可选] 标记来定义可选参数。例如下面的函数有 3 个参数，其中第 3 个参数是可选的：

/**
 * 计算两个数的和
 * @param {number} a - 第一个数字
 * @param {number} b - 第二个数字
 * @param {number} [c] - 可选的第三个数字
 * @return {number} 两个数的和
 */
function add(a, b, c) {
  if (typeof c === 'undefined') {
    c = 0;
  }
  return a + b + c;
}

在这个例子中，第 3 个参数 c 使用了 [可选] 标记来表示它是一个可选的参数。注意，在注释中定义可选参数时，必须将可选参数放在方括号内。

使用可选参数

使用可选参数时，可以不传递可选参数，此时该参数会被赋值为 undefined。也可以传递一个值，这个值会被赋值给该参数。例如：

add(1, 2, 3); // 返回 6
add(1, 2); // 返回 3
add(1, 2, undefined); // 返回 3

在上面的例子中，当调用 add 函数时，可以传递 2 个参数，也可以传递 3 个参数，第 3 个参数是可选的。如果没有传递第 3 个参数，则会被赋值为 undefined。如果传递了第 3 个参数，则会使用传递的值。

总结

使用 JSDoc 中的 [可选] 标记，可以定义可选参数，使得函数的参数更加灵活，可以根据不同的需求进行调用。在定义可选参数时，一定要记得将可选参数放在方括号内，否则会导致 JSDoc 解释错误。