如何使用JSDoc使用破折号记录字段

时间:2018-03-19 08:53:51

标签: javascript webstorm jsdoc jsdoc3

给定一个我不允许修改的对象定义:

let a = {"a-b" : 5};

如何在其上添加JSDoc?

我试过

/**
* @type {{"a-b": number}}
*/

但WebStorm告诉我这不是有效的JSDoc。

2 个答案:

答案 0 :(得分:1)

目前这是一个尚未解决但仍在进行中的话题。

我建议使用课堂评论:

/**
 * @typedef {Object}
 * @property {number} a-b
 */

答案 1 :(得分:1)

这是使用特殊控制元素记录名称路径的有效方法 - 请参阅http://usejsdoc.org/about-namepaths.html名称中包含特殊字符的对象的名称路径。但是WebStorm还不支持它 - 请参阅WEB-18032