İç içe geçmiş dizi ve nesne verilerini jsDoc ile belgeleme hakkında sorular

Question

Yuvalanmış dizileri ve nesneleri jsdoc kullanarak nasıl biçimlendiririm?

Bu benim en iyi tahminim:

an_obj = { 
     username1 : [ 
      { 
       param1 : "value 1-1-1", 
       param2 : "value 1-1-2", 
       optional_nested : "1-1--2" 
      }, 
      { 
       param1 : "value 1-2-1", 
       param2 : "value 1-2-2" 
      }, 
     ], 
     username2 : [ 
      { 
       param1 : "value 2-1-1", 
       param2 : "value 2-1-2" 
      }, 
      { 
       param1 : "value 2-2-1", 
       param2 : "value 2-2-2", 
       optional_nested : "2-2--2"    

      } 
     ] 
    } 
} 


/** 
* A function description. 
* @param {Object} obj 
* @param {Object} obj.username This is not the object name, but a name type. 
* @param {Array} obj.username.array Desc... using [] would conflict with optional params. 
*         However this could be confused with an object called array. 
* @param {String} obj.username.array.param1 Desc... This is the object name rather than a type. 
* @param {String} obj.username.array.param2 Desc... 
* @param {String} obj.username.array.[optional_param] Desc... 
*/ 
var myFunc = function(obj){ 
    //... 
}; 
myFunc(an_obj); 

nasıl bir nesne dize bir tür tarafından dizine belirtmek mı?

Yuvalanmış bir diziyi nasıl tanımlarım? Ayrıca, köşeli parantezleri isteğe bağlı parametreye nereye koyacağınızdan da emin değilsiniz.

Answer 1

this denetlemesini öneririm.

/** 
* @param {String[]} obj.username.array 
*/ 

Bu dizelerden oluşan bir dizi olarak obj.username.array beyan gerekiyordu (burada http://code.google.com/p/jsdoc-toolkit/wiki/TagParam belirtildiği gibi):

//{Object{username:<Array<Object{param1:String, param2:String,[optional_nest]:string}>>}} 

Answer 2

Böyle yapıyor deneyebilirsiniz: Muhtemelen o böyle bir şey yazmak istiyorum. jsdoc veya jsdoc3 kullanıyor musunuz?