jsdoc

How to document an array of objects in JSDOC

孤者浪人 提交于 2020-12-29 05:15:42
问题 I have a function with an array of objects as parameter and would like to describe the parameter (including the properties of the objects in the array) using JSDOC like in this example: /** * @param {Array.<Object>} filter - array of filter objects * @param ... */ function doSomething(filter) { } where filter is something like this: filter = [ {id: 'session', value: 1}, {id: 'name', value: 'john'} ] How would I document the properties id and value in jsdoc3 ? 回答1: like this: /** * @param

How to document an array of objects in JSDOC

六眼飞鱼酱① 提交于 2020-12-29 05:14:49
问题 I have a function with an array of objects as parameter and would like to describe the parameter (including the properties of the objects in the array) using JSDOC like in this example: /** * @param {Array.<Object>} filter - array of filter objects * @param ... */ function doSomething(filter) { } where filter is something like this: filter = [ {id: 'session', value: 1}, {id: 'name', value: 'john'} ] How would I document the properties id and value in jsdoc3 ? 回答1: like this: /** * @param