メソッドの "オブジェクト"パラメータを文書化する方法

Question

私はJavaScriptメソッドのドキュメントを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) { ..... } 

、オプションのオブジェクトは、私がこの@paramの文書にこの情報を追加するにはどうすればよいoptions.idのようないくつかのパラメータ、options.singleなどに

を持つことができますか？参照から

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. 

（以下の例では、 オプション）最初のオブジェクトを宣言しなければならない方法で受信されたオブジェクトを記述するために、書き込み時の現在のバージョンであるYUIDOC 0.3.45で

Answer 2

、次いでドット表記のプロパティです（たとえば、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 
*/