如何在JSDOC中記錄一個對象數組

Question

我有一個以對象數組爲參數的函數，並且希望使用JSDOC來描述參數（包括數組中的對象的屬性），如下例所示：

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

，其中過濾器是這樣的：

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

我怎麼會記錄屬性id和jsdoc3 value？

Answer 1

這樣的：從http://usejsdoc.org/tags-param.html採取

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