Javascript 不确定JSdocs时放置@return的内容
您好,我有一个函数,它返回该函数中某个函数的结果。所以我有点不确定在我的Javascript 不确定JSdocs时放置@return的内容,javascript,jsdoc,Javascript,Jsdoc,您好,我有一个函数,它返回该函数中某个函数的结果。所以我有点不确定在我的@return中放什么。我正在进入JSdocs,这是一个我偶然发现的问题 代码如下: /** * @param {string} id * @param {Array} data * @returns ?? * @description Takes in an ID to find the processor it needs and the data
@return
中放什么。我正在进入JSdocs,这是一个我偶然发现的问题
代码如下:
/**
* @param {string} id
* @param {Array} data
* @returns ??
* @description Takes in an ID to find the processor it needs and the data it needs to pass to the processor.
*/
processData(id, data) {
let res = Object.values(methods).find(entry => entry.id === id).dataProcessor;
if (res !== undefined) return res(data);
console.error(`There is no method that belongs to id:${id}`)
}
由于它返回的是
res.data(data)
的结果,您会在文档中的@return中输入什么 在这种情况下,我通常会返回一个{Object}
,或一个ALL{*}
,甚至一个ANY{?}
由您决定,如果您拥有的是复杂类型,只需提及其名称即可