22

オブジェクトの配列をパラメーターとして持つ関数があり、次の例のように JSDOC を使用してパラメーター (配列内のオブジェクトのプロパティを含む) を記述したいと考えています。

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

フィルターは次のようなものです。

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

idプロパティとvaluejsdoc3をどのように文書化しますか?

4

1 に答える 1

35

このような：

/**
 * @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から取得

于 2015-09-23T19:14:14.733 に答える