Jsdoc3 Kommentar Objekt

Question

Angenommen, ich habe ein Objekt, was ist die Art, es mit jsdoc3 zu kommentieren?

/** 
* Test object 
* @namespace test 
*/ 
var test = { 
    /** 
    * Some defaults 
    * @memberOf test 
    */ 
    defaults: { 
     'test1': 1, 
     'test2': 2 
    }, 
    /** 
    * Somthing else 
    * @memberOf test 
    */ 
    deep: { 
     /** 
     * Some option 
     * @memberOf {test.deep} 
     */ 
     option: {}, 
     /** 
     * Some method 
     * @memberOf test.deep 
     */ 
     method: {}, 
     /** 
     * Some option 
     * @memberOf {test.deep.evenMore} 
     */ 
     evenMore: { 
     /** 
     * Some option 
     * @memberOf test.deep.evenMore 
     */ 
     test: false 
     } 
    } 
}; 

Aber jsdoc schafft nur Dokumentation für Namensraum: Test und Mitglieder tief, defaults

Namespace: Test Test Test-Objekt

Mitglieder

tief Somthing sonst

Standardeinstellungen Einige Standardeinstellungen

Answer 1

Wie @Scottux sagte, ist die einzige Möglichkeit, dies zu erreichen, die Benennung zusätzlicher Namespaces.

/** 
* Test object 
* @namespace test 
*/ 
var test = { 
    /** 
    * Some defaults 
    * @memberOf test 
    */ 
    defaults: { 
     'test1': 1, 
     'test2': 2 
    }, 
    /** 
    * Somthing else 
    * @memberOf test 
    * @namespace test.deep 
    */ 
    deep: { 
     /** 
     * Some option 
     * @memberOf test.deep 
     */ 
     option: {}, 
     /** 
     * Some method 
     * @memberOf test.deep 
     */ 
     method: {}, 
     /** 
     * Some option 
     * @memberOf test.deep 
     * @namespace test.deep.evenMore 
     */ 
     evenMore: { 
     /** 
     * Some option 
     * @memberOf test.deep.evenMore 
     */ 
     test: false 
     } 
    } 
}; 

---

Die erzeugte Dokumentation wird wie folgt aussehen:

---