怎么在VSCode中使用Code Tour插件_VSCode代码导览创建与新人引导

雨婷酱_2123

雨婷酱_2123

2026-06-16

886人浏览

原创

codetour插件已停用,推荐用vscode原生机制替代:纯markdown file://链接或vscode-notebook+注释跳转,稳定兼容、无扩展依赖、路径可显式映射、错误提示明确。

怎么在vscode中使用code tour插件_vscode代码导览创建与新人引导

CodeTour 插件已不可用——微软于 2023 年底正式弃用并下架该扩展,当前 VSCode 市场中搜到的 code-tour-community 等复刻版,既不兼容原 .tour 格式,也无法在 GitHub Codespaces 或新版 VSCode 的 WebWorker 沙箱中正常运行。


CodeTour 安装失败或找不到插件的直接原因

  • 在 VSCode 扩展市场搜索 CodeTour,看到的全是社区复刻版,作者不是 Microsoft
  • 即使手动安装旧版 .vsix,也会因 API 变更(如 vscode.workspace.findFiles() 被沙箱限制)而报错或静默失效
  • 启动命令如 CodeTour: Start New Tour 在命令面板中完全不出现,说明插件未注册成功

替代方案:用 vscode-notebook + 注释跳转实现等效功能

核心思路是放弃“插件驱动跳转”,改用 VSCode 原生支持的机制:

  • 新建一个 onboarding.code-notebook 文件,类型设为 “Plain Text Notebook”
  • 每段 Markdown 单元格末尾加一行注释:<!-- goto: ./src/utils/auth.ts:42 -->
  • 编写极简脚本 goto.js(放在项目根目录),调用 vscode.window.showTextDocument() 解析该注释并跳转
  • 绑定快捷键(如 Ctrl+Alt+G)触发脚本,全程无扩展依赖

这样做的好处:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 不扫描整个工作区,大型 monorepo 下无卡顿
  • 路径解析可显式处理别名(如把 @/hooks/useApi 映射为真实路径)
  • 跳转失败时能弹出明确错误提示,而不是静默跳过

更轻量、更稳定的选择:纯 Markdown + file:// 链接

如果你只需要“点击即跳转”,不需要自动播放、步骤控制或高亮,这个方案最可靠:

  • 在 ./docs/guide.md 中写:@#@#@#@#@#@#@#@#@#@0
  • 路径必须是绝对路径,但可用 ${workspaceFolder} 变量(需开启设置 markdown.preview.useWorkspaceRoot)
  • 配合 markdown.extension.footnotes 插件,把每步讲解写成带编号脚注,避免长文档滚动迷失

注意:

  • file:// 链接在 Windows/macOS/Linux 全平台生效,且不依赖任何插件
  • Git 合并冲突几乎为零——Markdown 是文本,diff 清晰可读
  • 所有路径别名(如 @/、~/)需提前转换为真实相对路径,否则链接失效

真正容易被忽略的点是:导览的目的不是“做出酷炫动画”,而是让新人第一次打开项目就能精准定位、理解上下文、不卡在环境或路径上。越依赖插件、越追求自动播放,就越容易在升级、换机器、开 Codespaces 时崩掉。稳定压倒一切,而稳定来自 VSCode 原生能力——比如 file:// 链接、Notebook 注释解析、甚至只是右键菜单里的 “Go to Definition”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1415

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2972

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2009

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2607

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1838

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1262

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

494

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程