VSCode插件开发中文指南生成工具是面向开发者的CLI工具,能自动提取package.json和extension.ts结构,结合API变更与社区问题生成可嵌入README的结构化中文说明;它强调“不写会怎样”的后果而非单纯翻译,支持版本兼容检测、路径校验、本地化提醒等功能。

VSCode插件开发中文指南生成工具的核心定位
它不是翻译器,也不是文档搬运工;而是一个面向插件开发者、能自动提取 package.json 和 extension.ts 结构,结合 VS Code 官方 API 变更历史(如 1.83+ 的 activationEvents 规则调整)和社区高频问题(比如 vscode.extensionContext 资源泄漏),生成可直接嵌入项目 README 或内部 Wiki 的结构化中文说明的 CLI 工具。
为什么不能直接用机器翻译生成中文指南
机器翻译会把 context.subscriptions.push(disposable) 翻成“上下文订阅推送处置对象”,但开发者真正需要的是:这行代码漏写会导致插件重启后内存持续增长;它必须出现在 activate() 中,且不能在 deactivate() 里重复调用;如果注册了多个命令或事件监听器,每个都要单独 push。
- 中文指南要暴露“不写会怎样”的后果,而不是仅描述“它是什么”
-
activationEvents字段在 v1.80 后支持onLanguage:python,但旧版只认onCommand,工具需检测engines.vscode版本并给出兼容写法 - 插件图标路径写成
./icons/icon.png在 Windows 下可能因大小写敏感失效,工具应提示改用小写路径 +icon字段校验
如何用它生成一份可用的中文开发指南
假设你刚用 yo code 初始化了一个 TypeScript 插件项目,执行以下命令即可生成带上下文注释的中文说明:
npm install -g vscode-plugin-docgen vscode-plugin-docgen --input ./package.json --output ./docs/zh-CN.md
生成结果会包含:
- 对
contributes.commands每一项的中文功能说明,自动关联extension.ts中对应registerCommand的行号 - 把
activationEvents中的onStartup标注为“启动即激活,慎用——影响 VS Code 启动速度” - 检测到
main指向extension.js但项目是 TypeScript,则提示“需确保编译后路径一致,否则插件加载失败” - 若
repository.url为空,会建议补全,因为中文用户常忽略此字段导致发布时信息缺失
容易被忽略的本地化细节
中文指南生成工具本身不处理语言包,但它会扫描项目中是否声明了 contributes.menus 或 contributes.views,并提醒:这些 UI 元素的标题(title 字段)若硬编码为英文,即使装了中文语言包也不会汉化——必须改用 %command.title% 形式,并在 package.nls.json 中提供对应翻译键值对。
另外,vscode-language-pack-zh-hans 插件只汉化编辑器界面,不汉化你插件里的提示文字;vscode.window.showInformationMessage('Done') 这类字符串必须手动本地化,工具会在生成文档时标红警告这一行。


















