我有一个以对象数组作为参数的函数,并且想使用 JSDOC 描述参数(包括数组中对象的属性),如下例所示:
/**
* @param {Array.<Object>} filter - array of filter objects
* @param ...
*/
function doSomething(filter) {
}
其中过滤器是这样的:
filter = [
{id: 'session', value: 1},
{id: 'name', value: 'john'}
]
我将如何记录属性id
and value
在 jsdoc3 中?
像这样:
/**
* @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 http://usejsdoc.org/tags-param.html
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)