2017-06-20 98 views
5

如果我有一個JavaScript函數以一個對象作爲參數,我可以描述對象的預期性能與JSDoc這樣的:如何描述解構對象參數在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; 

回答

6

事實證明,JSDoc確實支持通過組成一個佔位符名稱進行破壞。它缺少官方文件。

https://github.com/jsdoc3/jsdoc/issues/987

/** 
* @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;