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;

Answer 2

我也有同样的问题。现在我正在使用Visual Code Studi，它的插件做了这样的事情（这适合我）：

/**
 * @param  {} {a
 * @param  {} b
 * @param  {} c}
 * @param  {} {d}
 */
const aaa = ({a,b,c},{d}) => {

}

如何在JSDoc中描述析构对象参数

2 个答案: