Comment documenter un paramètre « objet » d'une méthode

Question

Je suis en train d'écrire la documentation pour une méthode JavaScript à l'aide YUIDoc. Il ressemble à:

/** 
    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) { ..... } 

Maintenant, les options objet peut avoir plusieurs paramètres, comme options.id, options.single, etc.

Comment puis-je ajouter ces informations à la documentation de ce @param?

Answer 1

De référence: http://yui.github.com/yuidoc/syntax/index.html

«Comme le montre l'exemple, vous pouvez également les balises @param nid Cela vous permet de documenter les paramètres d'objets qui ont leur propre structure imbriquée particulière. »

@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

Dans YUIDOC 0.3.45, qui est la version en vigueur au moment de l'écriture, afin de décrire les objets reçus par les méthodes que vous devez d'abord déclarer l'objet (les options, dans l'exemple ci-dessous), puis ses propriétés avec une notation de points (par exemple, 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 
*/