CodeTour插件已不可用,微软于2023年底正式弃用并下架该扩展,当前搜索到的多为不兼容原格式的社区复刻版。

CodeTour插件是否还可用?2024年真实状态
CodeTour 插件已于 2023 年底被微软正式弃用,vscode-code-tour 扩展已从 Marketplace 下架,且不再接收更新。如果你在 VSCode 中搜索 “CodeTour”,看到的很可能是社区维护的复刻版(如 code-tour-community),但它们不兼容原官方格式,也不支持 GitHub Codespaces 或新版 VSCode 的 WebWorker 沙箱机制。
替代方案:用内置的 vscode-notebook + 自定义 Markdown 导览
VSCode 原生支持 Notebook(需启用 notebook.experimental.enableDefaultNotebook),配合轻量脚本可实现类似 CodeTour 的交互式讲解。关键不是“复刻功能”,而是达成目标——让新人点击一段说明,自动跳转到对应代码位置并高亮。
- 新建一个
onboarding.code-notebook文件,类型选 “Plain Text Notebook” - 每段 Markdown 单元格末尾加一行注释:
<!-- goto: ./src/utils/auth.ts:42 --> - 写个极简的
goto.js脚本(放在项目根目录),用vscode.window.showTextDocument()解析注释并跳转 - 绑定快捷键(如
Ctrl+Alt+G)触发该脚本,无需安装任何扩展
为什么不用第三方 Tour 插件?常见踩坑点
多数复刻插件依赖 vscode.workspace.findFiles() 或 vscode.workspace.textDocuments 实时扫描文件,但在大型 monorepo 中极易卡顿;更严重的是,它们无法正确解析 TypeScript 的路径别名(如 @/hooks),导致 goto: "@/hooks/useApi" 直接报错 File not found。
- 路径解析失败时,插件通常静默跳过,新人看不到任何提示,误以为“导览坏了”
- 所有基于装饰器(decoration)的高亮逻辑,在开启
"editor.smoothScrolling": true时会偏移 1–2 行 - 导览步骤保存为 JSON 文件后,Git 合并冲突概率极高——两个成员同时修改第 5 步,JSON diff 几乎不可读
真正轻量可靠的方案:纯 Markdown + 链接锚点
放弃“自动跳转”,改用 VSCode 原生支持的 file:/// 链接 + 行号锚点,既稳定又无依赖。VSCode 点击这类链接会直接打开文件并定位到行(Windows/macOS/Linux 全支持)。
- 在
./docs/guide.md中写:[查看登录逻辑](file:///path/to/your/project/src/pages/Login.vue#L87) - 路径必须是绝对路径,可用
${workspaceFolder}变量(需在 VSCode 设置中启用markdown.preview.useWorkspaceRoot) - 配合
markdown.extension.footnotes插件,把每步讲解写成带编号脚注,避免长文档滚动迷失 - 首次运行前执行一次
code --goto ./src/main.ts:1验证本地路径协议是否生效(某些企业策略会禁用 file:// 链接)
最麻烦的环节其实是路径拼写和权限——file:// 链接对空格、中文、特殊字符极其敏感,稍有不慎就打开空白页。建议所有路径统一用 path.posix.join() 格式化,并在 CI 中加一条检查脚本,验证所有 file:// 链接是否真实存在。


















