如何在JSDOC中记录对象数组

How to document an array of objects in JSDOC

本文关键字：记录 对象 数组 JSDOC      更新时间：2023-09-26

我有一个以对象数组为参数的函数，并且希望使用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 ?

像这样:

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

相关文章：