Bir yöntemin "nesne" parametresi nasıl kaydedilir

Question

YUIDoc kullanarak bir JavaScript yöntemi için bazı belgeler yazmaya çalışıyorum.

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

Şimdi, seçenekler çeşitli parametrelere sahip olabilir nesne

Nasıl bu @param belgelerine bu bilgiyi eklerim vb options.id, options.single gibi: Öyle görünüyor? referanstan

Answer 1

: http://yui.github.com/yuidoc/syntax/index.html

"örnekte gösterildiği gibi, iç içe @param etiketleri Bu kendi özel iç içe bir yapıya sahip nesne parametrelerini belgelemek için olanak olabilir."

@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. 

(aşağıdaki örnekte, seçenek) ilk nesne bildirmek gereken yöntemler ile alınan nesneleri tanımlamak için, yazma sırasında geçerli sürümü olan YUIDOC 0.3.45 olarak

Answer 2

ve sonra bir nokta gösterimi ile özellikleri (örneğin, 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 
*/