किसी विधि के "ऑब्जेक्ट" पैरामीटर को कैसे दस्तावेज़ित करें

Question

मैं YUIDoc का उपयोग कर जावास्क्रिप्ट विधि के लिए कुछ दस्तावेज़ लिखने की कोशिश कर रहा हूं। ऐसा लगता है कि:

/** 
    Returns an instance of className 

    @method getInstance 
    @param {string} className the of the class used to create the instance 
    @param {Object} options these are options used to create the instance 
**/ 
function getInstance(className, options) { ..... } 

अब, विकल्प आपत्ति कई मापदंडों हो सकता है, options.id, options.single की तरह, आदि

मैं इस @param के दस्तावेजीकरण के लिए इस जानकारी जोड़ सकता हूँ?

Answer 1

संदर्भ से: http://yui.github.com/yuidoc/syntax/index.html

"। के रूप में उदाहरण में दिखाया गया है, तो आप भी घोंसला @param टैग यह आपको अपने स्वयं के विशेष आंतरिक संरचना होती है कि वस्तु मानकों दस्तावेज़ के लिए सक्षम बनाता है सकते हैं।"

@param {Object} [options] Data 
    to be mixed into the event 
    facade of the `change` 
    event(s) for these attributes. 
    @param {Boolean} [options.silent] 
    If `true`, no `change` event 
    will be fired. 

Answer 2

YUIDOC 0.3.45 में, लेखन के समय वर्तमान संस्करण है जो आदेश (नीचे उदाहरण में, विकल्पों) तरीके आप पहली वस्तु घोषित करना चाहिए द्वारा प्राप्त वस्तुओं को वर्णित करने में, और उसके बाद यह एक डॉट नोटेशन के साथ गुण है (उदाहरण के लिए, options.url)।

/** 
* Describe your method 
* 
* @method yourMethodName 
* @param {object} options - These are the options you may pass 
* @param {string} options.url - the url 
* @param {string} options.otherOption - description of other option 
*/