如何利用VSCode的CodeTour插件制作代码导览?

云伟小哥_8184

云伟小哥_8184

2025-12-20

190人浏览

原创

CodeTour插件可在VSCode中创建结构化、可交互的分步代码导览:一、安装启用;二、创建新导览生成.tour文件;三、添加多文件步骤并绑定代码行;四、保存至.tours/目录并Git共享;五、播放时自动跳转高亮。

如何利用vscode的codetour插件制作代码导览?

如果您希望在VSCode中为团队成员或自己创建结构化、可交互的代码学习路径,则可以借助CodeTour插件实现分步式代码导览。以下是具体操作步骤:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装并启用CodeTour插件

CodeTour是一个由Microsoft官方维护的开源插件,需先在VSCode扩展市场中安装并激活,才能开始创建和播放导览。该插件支持跨文件跳转、注释嵌入与步骤导航,是构建代码上下文教学的关键工具。

1、打开VSCode,点击左侧活动栏中的扩展图标(或使用快捷键Ctrl+Shift+X / Cmd+Shift+X)。

2、在扩展搜索框中输入CodeTour,找到作者为Microsoft的官方插件。

3、点击“安装”按钮,安装完成后点击“重新加载”以启用插件。

二、创建新代码导览

新建导览将生成一个独立的.tour文件,其中记录了每一步的位置、标题、描述及关联代码行,便于版本控制和协作复用。

1、在VSCode任意打开的代码文件中,右键选择Create New Code Tour。

2、在弹出的输入框中为导览命名,例如api-handling-tour,按回车确认。

3、此时编辑器右下角状态栏出现Tour控件,且当前文件顶部显示新增的tour步骤编号标记。

三、添加导览步骤

每个步骤绑定到特定文件的具体行范围,用于聚焦讲解逻辑片段、关键变量或设计意图,支持多文件穿插组织。

1、将光标置于需讲解的第一行代码上,右键选择Add Step to Current Tour。

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载

2、在弹出的编辑框中输入该步骤的标题,例如“初始化请求配置对象”。

3、按下Enter后,在下方输入详细说明,如“此处定义默认超时与认证头,避免重复设置”。

4、重复上述操作,在其他文件或同一文件不同位置继续添加步骤,形成完整流程链。

四、保存并共享导览文件

导览数据以JSON格式存储于项目根目录下的.tours子文件夹中,可直接提交至Git仓库,供他人克隆后立即播放。

1、点击VSCode右下角Tour状态栏中的Save Tour按钮(软盘图标)。

2、确认保存路径为项目根目录下的.tours/文件夹,文件名自动匹配导览名称并添加.json后缀。

3、在终端中执行git add .tours/,将导览文件纳入版本管理。

五、播放已有导览

播放模式提供逐帧导航、自动高亮目标代码块及内联说明浮层,降低理解门槛,尤其适用于新人 onboard 流程。

1、在资源管理器中右键点击已存在的.tour文件,选择Play Tour。

2、播放启动后,编辑器自动跳转至第一步所指定的文件与行号,并高亮显示对应代码区域。

3、使用右下角Tour控制栏中的Next按钮推进至后续步骤,或点击Previous返回上一步。

相关文章

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

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

下载

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

相关专题

更多
json数据格式
json数据格式

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

2023.08.07

2395

5

json是什么
json是什么

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

2023.08.23

3962

1

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

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

2023.10.13

1316

3

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

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

2025.09.10

4599

7

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

7799

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

2140

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1274

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

5037

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

5041

6

热门下载

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

精品课程

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