有關使用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

我建議你檢查這出。 我可能會寫這樣的東西：

//{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？