我正在尝试在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呢？
没有很好的答案在这里。
答案是简单而美丽的：
/**
* Some documentation.
*
* @return {Map<String, Object>}
*/
function returningMap() {
const someMap = new Map();
someMap.set("key", {a, b, c});
return someMap;
}
基本模式是Map<KeyType, ValueType>。根据您的示例，键将是一个字符串，并为一个对象赋值。您甚至可以继续声明您的对象。例如：
/**
* @typedef {Object} MyObject
* @property {Number} a
* @property {Number} b
* @property {String} c
*/
然后您的地图将声明为Map<String, MyObject>。不错，不是吗？您还可以嵌套其他地图甚至集合，例如Map<Number, Set<MyObject>>。
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
我来说两句