如何在JSDOC中记录对象数组

时间:2015-08-30 09:53:03

标签: javascript jsdoc jsdoc3

我有一个带有对象数组作为参数的函数,并希望使用JSDOC来描述参数(包括数组中对象的属性),如下例所示:

/**
 * @param {Array.<Object>} filter - array of filter objects
 * @param ...
 */
function doSomething(filter) {
}

其中filter是这样的:

filter = [
   {id: 'session', value: 1},
   {id: 'name', value: 'john'}
]

如何在jsdoc3中记录属性idvalue

1 个答案:

答案 0 :(得分:12)

像这样:

/**
 * @param {Object[]} filter - a list of literal filter objects
 * @param {string} filter[].id -  id to filter against...
 * @param {string|number} filter[].value - value to filter for...
 */
function doSomething(filter) {
    // do stuff
}

取自http://usejsdoc.org/tags-param.html