如果我有一个将对象作为参数的 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 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;
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)