visual-studio-code - 对象键中的jsdoc连字符

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

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

最佳答案

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

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

为

类型创建一个文件夹

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

关于visual-studio-code - 对象键中的jsdoc连字符，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/53963751/