Javascript JsDoc：如何记录像地图这样的新ES6数据类型？

我正在尝试在我的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>>.

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 [e-mail] 举报，一经查实，本站将立刻删除。