如何在 JSDoc 中记录数组解构参数

【问题标题】：How to document array destructured parameter in JSDoc如何在 JSDoc 中记录数组解构参数
【发布时间】：2020-05-21 14:42:53
【问题描述】：

鉴于以下代码，我如何使用最新的 JSDoc 正确记录？

function docMe([foo, bar = null, baz = 1]) { 
  /* */ 
}

我试过这个：

/**
 * @param {Array} options Array containing the options.
 * @param {HTMLElement} options[0].foo An HTML element.
 * @param {Object} [options[1].bar] An object.
 * @param {Number} [options[2].baz] A number.
 */

显然这不起作用，JSDoc 文档提到的只是如何记录解构的 object 参数，而不是解构的 array 参数。

【问题讨论】：

标签： javascript jsdoc destructuring jsdoc3

【解决方案1】：

在撰写本文时，闭包编译器中有an open issue。

该线程产生 3 个不完美的解决方案：

1:@param for JSDocs3:

/**
 * Assign the project to an employee.
 * @param {Array} param1
 * @param {string} param1.foo
 * @param {*?} param1.bar
 * @param {number} param1.baz
 */
function docMe([foo, bar = null, baz = 1]) {
    // ...
};

2：报告在 VSCode 中工作（我不是用户，所以无法确认）

/**
 * @param {[foo, bar, baz]: [string, *, Number]} param1
 */
function docMe([foo, bar = null, baz = 1]) {
  // ...
}

3：对于闭包编译器：等待the issue 被解析并使用该格式。它显然正在等待修复，并且已解除阻止，因此希望它很快得到解决。

【讨论】：