如何使用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);
如何表示一个对象被一个字符串索引？
如何定义嵌套数组？
也不知道把方括号放在可选参数中的位置.
解决方法
我建议检查
this.我可能写这样的东西：
//{Object{username:<Array<Object{param1:String,param2:String,[optional_nest]:string}>>}}