我正在尝试在我的ES6项目中使用JSDoc,我正在返回一个Map：
/**
* Some documentation..
*
* @returns {undefined} <- This should be replaced
*/
function returningMap() {
const someMap = new Map();
someMap.set("key",{a,b,c});
return someMap;
}
我应该如何用@returns记录这个？
here没有好的答案.
最佳答案
答案简单而美观：
/**
* Some documentation.
*
* @return {Map基本模式是Map< KeyType,ValueType>.从您的示例中,key将是一个字符串并且值为一个对象.您甚至可以继续声明您的对象.例如：
/**
* @typedef {Object} MyObject
* @property {Number} a
* @property {Number} b
* @property {String} c
*/
然后你的地图将被声明为Map< String,MyObject>.很酷,不是吗？您还可以嵌套其他地图甚至集合,例如Map< Number,Set< MyObject>>.
