jsdoc-tsimport-plugin支持TypeScript模块导入的JSDoc插件解析
插件简介
jsdoc-tsimport-plugin 是一个专为 JSDoc 提供支持 TypeScript 模块导入语法的插件。该插件解决了 JSDoc 在导入 typedef 时遇到的跨工具兼容问题。
在标准 JSDoc 中，导入自定义类型通常写为：
/**
* @type {module:path/to/module~MyTypeDefName}
*/
但 VSCode 和 WebStorm 等编辑器倾向于另一种更符合 TypeScript 的方式：
/**
* @type {typeof import("./path/to/module").MyTypeDefName}
*/
插件的作用
jsdoc-tsimport-plugin 添加了一个钩子，将上述编辑器支持的 TypeScript 样式语法转换为 JSDoc 所期望的格式。这样一来，开发者可以在文档注释中使用 TypeScript 风格的导入，而插件会在构建 JSDoc 时自动完成语法的兼容转换。
为什么需要这个插件？
该插件的核心优势在于便于将自定义类型定义在共享文件中，方便不同项目的复用。同时，它解决了在 JSDoc 生成过程中因导入语法差异导致的兼容问题。开发者无需手动调整语法格式，即可同时满足 VSCode 和 WebStorm 的代码提示需求。
文件大小：22.99KB
评论区