JSDoc में पैरामीटर या रिटर्न मान के रूप में ऑब्जेक्ट की एक सरणी कैसे निर्दिष्ट करें?

Question

JSDoc में, मुझे सबसे अच्छा प्रलेखन मिल सकता है यदि आप एक विशिष्ट प्रकार की एक सरणी (जैसे स्ट्रिंग्स की एक सरणी) के रूप में निम्न का उपयोग करने के लिए शो दिखा सकते हैं:

/**
 * @param {Array.<string>} myStrings All my awesome strings
 */
 function blah(myStrings){
     //stuff here...
 }

आप नीचे दिए गए प्रश्न चिह्नों की जगह वस्तुओं की एक सरणी कैसे निर्दिष्ट करेंगे?

/**
 * @param {???????} myObjects All of my equally awesome objects
 */
 function blah(myObjects){
     //stuff here...
 }

Comments

डॉक्युमेंट कलेक्शन (टाइप ऑफ

— अरेंजमेंट

Answer 1

आपको अधिक विशिष्ट होना चाहिए जो आप JSDoc से मतलब रखते हैं - यह एक सामान्य शब्द है जो जावास्क्रिप्ट के साथ सभी जावाडॉक-शैली के दस्तावेज़ीकरण टूल को कवर करता है।

स्ट्रिंग के सरणी के लिए आपने जो सिंटैक्स का उपयोग किया है, वह Google क्लोजर कंपाइलर द्वारा समर्थित है ।

इसका उपयोग करना, वस्तुओं की एक सरणी होगी:

/**
 * @param {Array.<Object>} myObjects
 */

या किसी भी चीज़ की एक सरणी - यह बहुत सभी डॉक्टर उपकरण के साथ काम करना चाहिए:

/**
 * @param {Array} myArray
 */

jsdoc-टूलकिट , JSDoc 3 , और JSDuck वस्तुओं के एक सरणी को दर्शाने के लिए निम्नलिखित सिंटैक्स का समर्थन करते हैं:

/**
 * @param {Object[]} myArray
 */

---

संपादित करें

मामले में आप उन कुंजियों और चर प्रकारों को जानते हैं जिन्हें आप भी कर सकते हैं:

/**
 * @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
 */

या

/**
 * @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
 */

Comments

द। नोटेशन को अब हटा दिया गया है और बाद में इसका समर्थन छोड़ दिया जाना चाहिए। वर्तमान सही संस्करण है {Array<Object>}। बस इस पोस्ट को अपडेट रखना है।

— केनी806

JSDoc 3 के साथ, आप स्ट्रिंग सरणियों की एक सरणी कैसे लिखेंगे? पुराने वाक्य रचना में मैं कुछ ऐसा कर सकता हूंArray.<string[]>

— स्नेक

@ केनी806 पदावनत? एक संदर्भ दस्तावेज़ कृपया?

— विल्ट

@Wilt: कोण ब्रैकेट से पहले डॉट के बारे में JSDoc प्रलेखन विरोधाभासी है ।

— Dan Dascalescu

यह उत्तर यह नहीं समझाता है कि उस एरे में ऑब्जेक्ट्स की कुंजियों को कैसे घोषित किया जाए, और रिटर्न टाइप के रूप में विशिष्ट कुंजियों के साथ ऑब्जेक्ट्स के ऐरे को कैसे घोषित किया जाए। यह उत्तर देता है।

— दान डैस्कलेस्कु