2017-06-20 6 views
5

में destructured वस्तु तर्क वर्णन करने के लिए अगर मैं एक JavaScript फ़ंक्शन एक पैरामीटर के रूप एक वस्तु लेने के लिए है, मैं इस तरह JSDoc के साथ वस्तु की उम्मीद गुण का वर्णन कर सकते हैं:कैसे JSDoc

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

मैं इन गुणों का वर्णन किस प्रकार करते हैं यदि मैं अपने कार्य को ईसीएमएस्क्रिप्ट 6 विनाशकारी के साथ परिभाषित करता हूं, तो वास्तविक पैरामीटर ऑब्जेक्ट को बिल्कुल नाम नहीं दे रहा है?

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

उत्तर

6

यह JSDoc एक प्लेसहोल्डर नाम बनाने के माध्यम से destructing का समर्थन करता है पता चला है। आधिकारिक दस्तावेज में इसकी कमी है।

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; 
संबंधित मुद्दे