VSCode的CodeTour插件:用代码导览功能分享知识

浅辰酱_2506

浅辰酱_2506

2026-01-11

245人浏览

原创

CodeTour插件支持在VSCode中创建交互式代码导览,涵盖安装、新建导览、添加步骤、播放分享及多导览管理全流程,便于团队知识传递。

vscode的codetour插件:用代码导览功能分享知识

如果您希望在VSCode中通过结构化的方式向团队成员展示代码逻辑、功能模块或开发流程,则可能是由于缺乏直观的上下文引导。CodeTour插件提供了一种嵌入式、可交互的代码导览机制,支持逐行注释、路径跳转与步骤回放。以下是使用该插件构建并分享知识导览的具体操作:

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

一、安装并启用CodeTour插件

CodeTour作为VSCode官方推荐的导览工具,需先从扩展市场安装并激活,确保其能识别当前工作区中的代码文件与注释结构。

1、打开VSCode,点击左侧活动栏的扩展图标(四个方块组成的图标)。

2、在搜索框中输入CodeTour,找到由Microsoft发布的官方插件。

3、点击“安装”,安装完成后点击“重新加载”使插件生效。

二、创建首个代码导览

导览以JSON格式存储在工作区根目录下的.tours文件夹中,每条导览包含多个步骤,每个步骤绑定到特定文件与行号,形成可复现的阅读路径。

1、在VSCode中打开目标项目,确保已打开至少一个源码文件。

2、按下Cmd+Shift+P(Mac)调出命令面板,输入并选择CodeTour: Start New Tour。

3、在弹出的输入框中为导览命名,例如API初始化流程,回车确认。

4、光标所在位置将自动成为第一步,输入描述性文字后按Enter提交该步骤。

三、编辑与扩展导览步骤

已有导览可通过命令面板追加步骤,也可直接修改.tours目录下对应JSON文件,实现跨文件、跨函数的逻辑串联。

1、将编辑光标移至另一处关键代码行,如某个配置加载函数内部。

2、再次调用命令面板,执行CodeTour: Add Step to Current Tour。

Mailtrap Node.js SDK 用于事务性和沙盒电子邮件
Mailtrap Node.js SDK 用于事务性和沙盒电子邮件

一个基于官方 Mailtrap Node.js SDK 构建的 ASE 技能,用于发送事务邮件并与 Mailtrap 沙盒或生产流程协作。它非常适合需要 API 驱动邮件投递、测试邮箱验证和结构化消息自动化的代理工作流。

下载

3、输入说明文本,例如“此处完成环境变量注入”,确认添加。

4、重复操作可插入任意数量步骤,支持在不同文件间自由切换并绑定。

四、播放与分享导览内容

导览可本地播放供个人回顾,也可导出为独立JSON文件供他人导入,无需额外依赖即可还原完整浏览路径与注释。

1、在命令面板中执行CodeTour: Play Current Tour,开始逐帧播放。

2、播放过程中,编辑器自动跳转至各步骤对应位置,并高亮显示当前行及注释气泡。

3、右键点击任意步骤,在上下文菜单中选择Export Tour,保存为.tour.json文件。

4、接收者将该文件放入自己项目的.tours目录后,执行CodeTour: Import Tour即可加载。

五、管理多个导览与标签分类

同一项目可存在多个导览,通过命名区分用途;插件支持为导览添加标签,便于在命令面板中快速筛选与启动。

1、在命令面板中执行CodeTour: Manage Tours,打开导览管理视图。

2、在列表中右键某条导览,选择Edit Tour Metadata。

3、在弹出表单中填写tags字段,例如输入backend, auth(英文逗号分隔)。

4、后续调用播放命令时,可在命令面板中输入标签关键词快速定位相关导览。

相关专题

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

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

2023.08.07

2355

5

json是什么
json是什么

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

2023.08.23

3902

1

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

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

2023.10.13

1296

3

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

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

2025.09.10

4539

7

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

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

2023.06.30

1655

18

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

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

2023.07.21

3592

3

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

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

2024.03.14

2169

12

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

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

2024.03.14

1767

8

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

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

2024.03.15

2647

12

热门下载

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

精品课程

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