關於用jsDoc記錄嵌套數組和對象數據的問題

Question

如何使用jsdoc格式化嵌套數組和對象？

這是我最好的猜測：

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); 

我如何表明一個對象被一種字符串的索引？如何定義嵌套數組？

還不確定在可選參數中放置方括號的位置。

Answer 1

我建議檢查this了。我可能會寫這樣的事：

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

Answer 2

你可以嘗試做這樣的：（這裏http://code.google.com/p/jsdoc-toolkit/wiki/TagParam指定）

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

這應該申報obj.username.array作爲一個字符串數組。 您使用的是jsdoc還是jsdoc3？