javascript - 如何在 JSDoc 中描述解构的对象参数

Question

如果我有一个将对象作为参数的 JavaScript 函数，我可以像这样使用 JSDoc 描述对象的预期属性:

/**
 * @param bar
 * @param bar.baz {number}
 * @param bar.qux {number}
 */
function foo(bar) {
    return bar.baz + bar.qux;
}

如果我使用 ECMAScript 6 解构定义我的函数，而根本没有为实际参数对象命名，我该如何描述这些属性？

const foo = ({ baz, qux }) => baz + qux;

Answer 1

事实证明，JSDoc 确实支持通过构成占位符名称进行解构。缺少官方文档。

http://usejsdoc.org/tags-param.html#parameters-with-properties

/**
 * @param {Object} param - this is object param
 * @param {number} param.baz - this is property param
 * @param {number} param.qux - this is property param
 */
const foo = ({ baz, qux }) => baz + qux;