我在哪里可以存储JSDoc typedef信息以在项目之间共享?

时间:2018-08-30 21:46:05

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

我在Javascript文件的顶部添加了@typedef JSDoc注释,以帮助定义类型(的确,这样一来,我无需学习今天的全部内容,就可以利用某些打字稿的好处)。

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

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

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

1 个答案:

答案 0 :(得分:3)

您可以将该代码段放入.js文件中,然后将其添加到每个files文件的includetsconfig.json中,或使用引用指令:< / p>

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

(对于TypeScript声明文件,这两个选项是相同的。)如果共享文件是ES6模块(具有顶级ES6导入或导出),则会变得更加复杂。那么您将需要导入它或使用import types