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 命令。

ECTouch移动商城系统
ECTouch移动商城系统

ECTouch是上海商创网络科技有限公司推出的一套基于 PHP 和 MySQL 数据库构建的开源且易于使用的移动商城网店系统!应用于各种服务器平台的高效、快速和易于管理的网店解决方案,采用稳定的MVC框架开发,完美对接ecshop系统与模板堂众多模板,为中小企业提供最佳的移动电商解决方案。ECTouch程序源代码完全无加密。安装时只需将已集成的文件夹放进指定位置,通过浏览器访问一键安装,无需对已有

下载

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、将链接或文件发送给协作者,对方在相同代码路径下打开即可同步播放。

相关专题

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

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

404

2023.08.07

json是什么
json是什么

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

531

2023.08.23

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

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

308

2023.10.13

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

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

74

2025.09.10

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

603

2023.06.14

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

643

2023.06.21

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

464

2023.07.31

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

245

2023.08.01

漫蛙2入口地址合集
漫蛙2入口地址合集

本专题整合了漫蛙2入口汇总,阅读专题下面的文章了解更多详细内容。

162

2026.01.06

热门下载

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

精品课程

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

共34课时 | 2.5万人学习

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

共98课时 | 7.3万人学习

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

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