如何在JSDOC中记录一个对象数组

Question

我有一个以对象数组为参数的函数，并且希望使用JSDOC来描述参数（包括数组中的对象的属性），如下例所示：

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

，其中过滤器是这样的：

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

我怎么会记录属性id和jsdoc3 value？

Answer 1

这样的：从http://usejsdoc.org/tags-param.html采取

/** 
* @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 
}