代码之家  ›  专栏  ›  技术社区  ›  d-_-b

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

  •  1
  • d-_-b  · 技术社区  · 7 年前

    @typedef JSDoc将注释添加到Javascript文件的顶部,以帮助定义类型(实际上,这样我就可以利用typescript的一些优点,而不必今天全部学习)。

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

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

    /**
     * @typedef {Object} SomeType
     * @property {String} id
     */
    
    1 回复  |  直到 7 年前
        1
  •  5
  •   Matt McCutchen    7 年前

    你可以把代码片段放在 .js files include 在每个 tsconfig.json 文件或使用引用指令:

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

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

    推荐文章