对象键中的jsdoc连字符答案

【问题标题】：jsdoc hyphen in object key对象键中的jsdoc连字符
【发布时间】：2019-01-24 07:05:39
【问题描述】：

从包含连字符的 API 返回一个对象。我无法在 VS Code 中使用 JSDoc 记录这一点。在 VS Code ~~JSDoc~~ 中，连字符和连字符后面的所有内容都被忽略。我也试过Object.<string, string>。

/**
 * @typedef MyAPIResponse
 * @type {object}
 *
 * @property {string} X-Request-Id
 * @property {string} X-Correlation-Id
 */

【问题讨论】：

【解决方案1】：

通过使用 TypeScript 声明和triple slash directive 解决。

由于我没有在项目中使用 TypeScript，所以我做了以下操作：

为类型创建文件夹
向 JavaScript 文件添加三斜杠指令。示例：<reference path="./types/my-model.d.ts" /> 或使用 jsconfig.json

【讨论】：