【问题标题】：Where can I store JSDoc typedef information to share across projects?我在哪里可以存储 JSDoc typedef 信息以跨项目共享？
【发布时间】：2019-02-05 21:58:11
【问题描述】：

我将 @typedefJSDoc cmets 添加到 Javascript 文件的顶部以帮助定义类型（真的，这样我就可以利用 typescript 的一些好处而无需今天全部学习）。

我在哪里可以存储 JSDoc typedef 信息以便在 VSCode 中跨项目共享？

例如，我可以将它存储在某个外部文件中，然后在多个.js 文件中使用它吗？

/**
 * @typedef {Object} SomeType
 * @property {String} id
 */

【问题讨论】：

标签： node.js typescript visual-studio-code jsdoc

【解决方案1】：

2021 年更新

编辑tsconfig.json 使includes 相对于您的项目的根目录，并且还包括您的类型文件。例如：

{
    "compilerOptions": {
      // ...
    },
    "include": ["./my-types.js", "src/**/*.js"],
}

如果您没有将任何项目嵌套在 src/ 之类的文件夹下，那么这将单独运行：

{
    "compilerOptions": {
      // ...
    },
    "include": ["**/*.js"],
}

原答案

您可以将该代码 sn-p 放入 .js 文件中，然后将其添加到每个 tsconfig.json 文件中的 files 或 include 或使用引用指令：

///<reference path="path/to/shared-file.js" />

（这与 TypeScript 声明文件的两个选项相同。）如果您的共享文件是 ES6 模块（具有顶级 ES6 导入或导出），它会变得更复杂一些；那么您需要导入它或使用import types。

【讨论】：