[英]How to describe destructured object arguments in JSDoc
如果我有一个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;
事实证明,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;
我也有同样的问题。 现在我使用Visual Code Studi,它的插件做了这样的事情(这适合我):
/**
* @param {} {a
* @param {} b
* @param {} c}
* @param {} {d}
*/
const aaa = ({a,b,c},{d}) => {
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.