如何在 JSDOC 中记录对象数组

Question

我有一个以对象数组作为参数的函数，我想使用 JSDOC 描述参数（包括数组中对象的属性），如本例所示：

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

过滤器是这样的：

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

如何在 jsdoc3 中记录属性 id 和 value？

Answer 1

像这样：

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

如何在 JSDOC 中记录对象数组

How to document an array of objects in JSDOC

javascript

jsdoc

jsdoc3