对象键中的 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，所以我做了以下操作：

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

jsdoc hyphen in object key