对象键中的jsdoc连字符

Question

从包含连字符的API返回一个对象。我在VS Code中用JSDoc记录此文档时遇到麻烦。在VS Code JSDoc 中，连字符和连字符后的所有内容都将被忽略。我也尝试过Object.<string, string>。

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

Answer 1

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

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

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