时间戳

首页 > 解决方案 > 对象键中的jsdoc连字符

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
 */

标签： visual-studio-codejsdoc

解决方案

通过使用 TypeScript 声明和三斜杠指令解决。

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

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

推荐阅读