0

0

VSCode的Code Tour:创建代码库导览

P粉986688829

P粉986688829

发布时间:2026-01-04 18:16:58

|

232人浏览过

|

来源于php中文网

原创

VSCode的Code Tour扩展支持创建交互式代码库导览,包括安装扩展、初始化.tour文件、添加带注释标记的步骤、手动编辑JSON调整逻辑,以及播放和分享导览。

vscode的code tour:创建代码库导览

如果您希望为团队成员或新贡献者提供一个结构化的代码库导航体验,VSCode 的 Code Tour 扩展可帮助您以交互式方式创建分步导览。以下是创建代码库导览的具体操作流程:

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

一、安装 Code Tour 扩展

Code Tour 功能由独立扩展提供,需先在 VSCode 扩展市场中安装官方支持的插件,确保具备创建和播放导览的基础能力。

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

2、在搜索框中输入 Code Tour,找到由 Microsoft 发布的官方扩展。

3、点击“安装”按钮,等待安装完成并重启 VSCode(如提示需要)。

二、初始化首个 Tour 文件

每个导览以 JSON 格式的 .tour 文件形式存在,初始化过程会自动创建该文件并关联当前工作区根目录,便于后续编辑与版本管理。

1、按下 Cmd+Shift+P 打开命令面板。

2、输入并选择 Tour: Create Tour 命令。

3、在弹出的输入框中为导览命名,例如 getting-started,回车确认。

4、VSCode 将在工作区根目录下生成 .vscode/getting-started.tour 文件。

三、添加导览步骤到指定代码位置

导览步骤需锚定在具体代码行上,通过插入注释标记实现精准定位;每一步骤包含标题、描述及可选代码片段,支持跨文件跳转。

1、打开目标源码文件,将光标置于希望讲解的某一行代码上(例如函数定义首行)。

2、按下 Cmd+Shift+P,执行 Tour: Add Step 命令。

Mokker AI
Mokker AI

AI产品图添加背景

下载

3、在弹出的输入框中依次填写:标题(如“入口函数定义”)、描述(如“这是应用启动时调用的主函数”)。

4、确认后,VSCode 会在该行上方插入形如 // #region tour: getting-started step: 1 的注释块,并自动写入对应元数据。

四、编辑 Tour 文件手动调整顺序与内容

.tour 文件本质是 JSON,直接编辑可修改步骤顺序、增删步骤、补充代码高亮片段或调整跳转目标,适合精细化控制导览逻辑。

1、在资源管理器中双击打开 .vscode/getting-started.tour

2、找到 steps 数组,确认各步骤的 filelinetitledescription 字段是否准确。

3、如需插入中间步骤,可在数组中手动添加新对象,确保 line 值指向有效源码行号。

4、保存文件后,已存在的导览将立即反映变更,无需重启 VSCode。

五、播放与分享导览

播放功能提供内嵌式引导界面,支持暂停、跳转与退出;导览文件可随代码库提交,其他用户检出后即可直接运行。

1、打开命令面板,执行 Tour: Play Tour

2、从列表中选择 getting-started,导览界面将在编辑器右侧滑出。

3、点击右上角 Share 按钮,复制生成的 Markdown 链接或导出为独立 HTML 文件。

4、将链接或文件发送给协作者,对方在相同代码路径下打开即可同步播放。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

457

2023.08.07

json是什么
json是什么

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

547

2023.08.23

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

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

335

2023.10.13

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

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

82

2025.09.10

vscode
vscode

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

628

2023.06.30

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

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

228

2023.07.21

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

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

414

2024.03.14

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

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

393

2024.03.14

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.7万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 8.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号