我有一个带有一个对象数组作为参数的函数,并希望使用JSDOC来描述参数(包括数组中对象的属性),如下例所示：
/**
* @param {Array.<Object>} filter - array of filter objects
* @param ...
*/
function doSomething(filter) {
}
过滤器是这样的：
filter = [
{id: 'session',value: 1},{id: 'name',value: 'john'}
]
我如何在jsdoc3中记录属性id和值？
解决方法
像这样：
/**
* @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