VSCode使用CodeTour功能_为新团队成员制作代码功能讲解导览

千明吖_5715

千明吖_5715

2026-04-14

403人浏览

原创

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

vscode使用codetour功能_为新团队成员制作代码功能讲解导览

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.js 脚本(放在项目根目录),用 vscode.window.showTextDocument() 解析注释并跳转
  • 绑定快捷键(如 Ctrl+Alt+G)触发该脚本,无需安装任何扩展

为什么不用第三方 Tour 插件?常见踩坑点

多数复刻插件依赖 vscode.workspace.findFiles() 或 vscode.workspace.textDocuments 实时扫描文件,但在大型 monorepo 中极易卡顿;更严重的是,它们无法正确解析 TypeScript 的路径别名(如 @/hooks),导致 goto: "@/hooks/useApi" 直接报错 File not found。

VSCode
VSCode

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

下载
  • 路径解析失败时,插件通常静默跳过,新人看不到任何提示,误以为“导览坏了”
  • 所有基于装饰器(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:// 链接是否真实存在。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

332

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

540

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

411

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

326

29

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

2026.06.16

758

8

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2335

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3822

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1256

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4419

7

热门下载

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

精品课程

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