0

0

如何使用Code Tour插件为你的VSCode项目创建交互式导览

P粉986688829

P粉986688829

发布时间:2026-01-05 14:58:56

|

243人浏览过

|

来源于php中文网

原创

Code Tour 是 VS Code 官方轻量交互式代码导览插件,以 JSON 文件存于项目中,支持 Markdown 注释、步骤跳转、命令执行、条件显示及变量注入,开箱即用,适合上手引导与教学。

如何使用code tour插件为你的vscode项目创建交互式导览

Code Tour 插件能帮你为 VS Code 项目创建轻量、可运行、带注释的交互式导览,适合新成员上手、代码评审说明或教学演示。它不依赖外部服务,所有内容以 JSON 文件形式存于项目中,开箱即用。

安装与基础配置

在 VS Code 扩展市场搜索 “Code Tour”,安装由 Microsoft 发布的官方插件(图标为指南针)。安装后无需额外配置,重启 VS Code 即可生效。项目根目录下会自动生成 .code-tour 文件夹(首次创建导览时自动建立),里面存放每个导览的 JSON 文件,例如 onboarding.tourauth-flow.tour

快速创建第一个导览

打开你想引导的源码文件(如 src/App.tsx),右键选择 “Create Code Tour”,输入名称(如 “App 组件概览”),回车确认。接着在关键行号上右键 → “Add Step”,输入说明文字(支持 Markdown,如加粗、列表、代码块)。每步可指定文件、行号、焦点区域(如 12-15)和可选命令(如 “保存文件”、“运行测试”)。

  • 步骤支持跳转:点击步骤中的文件路径或行号,自动打开并定位
  • 可插入命令:比如 workbench.action.terminal.toggleTerminal 打开终端
  • 支持条件跳过:用 "when": "editorTextFocus && editorLangId == 'typescript' 控制显示逻辑

运行与分享导览

Ctrl+Shift+P(Win/Linux)或 Cmd+Shift+P(Mac),输入 “Code Tour: Start Tour”,选择对应 .tour 文件即可启动。界面左侧出现导航面板,支持播放/暂停、跳步、返回、退出。导览过程中编辑器聚焦变化、高亮当前行,体验接近真实讲解。

uBrand
uBrand

一站式AI品牌创建平台,在线品牌设计,AI品牌策划,智能品牌营销;uBrand帮助创业者轻松打造个性品牌!

下载
  • 导览文件是纯 JSON,可直接提交到 Git,团队成员拉取后立即可用
  • 支持多语言:步骤描述中嵌入中文无问题,语法高亮随当前文件语言自动匹配
  • 可在 README.md 中添加链接:[查看登录流程导览](.code-tour/auth-flow.tour),VS Code 点击即启动

进阶技巧与注意事项

导览不是静态文档,而是“可执行的上下文”。你可以用变量注入动态信息,比如 ${workspaceFolder}${fileBasename};也可用 "autoReveal": false 避免自动滚动干扰用户操作。注意避免步骤过多(建议单个导览 ≤ 12 步),复杂流程可拆分为多个主题导览(如 “数据获取”、“错误处理”、“状态更新”)。

  • 修改导览后无需重启 VS Code,保存 JSON 即实时生效
  • 删除某步?直接在 .tour 文件中删掉对应 step 对象,或右键步骤 → “Remove Step”
  • 调试提示:若步骤不显示,检查文件路径是否为相对路径(推荐用 ./src/...)、行号是否存在

基本上就这些。Code Tour 的价值不在炫技,而在把“口头说一遍”的引导,变成可复现、可迭代、可沉淀的轻量交互资产。

相关专题

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

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

406

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的详细内容,可以访问本专题下面的文章。

309

2023.10.13

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

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

74

2025.09.10

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

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

637

2023.07.05

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

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

525

2023.07.06

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

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

264

2023.07.24

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

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

541

2024.04.09

Golang 分布式缓存与高可用架构
Golang 分布式缓存与高可用架构

本专题系统讲解 Golang 在分布式缓存与高可用系统中的应用,涵盖缓存设计原理、Redis/Etcd集成、数据一致性与过期策略、分布式锁、缓存穿透/雪崩/击穿解决方案,以及高可用架构设计。通过实战案例,帮助开发者掌握 如何使用 Go 构建稳定、高性能的分布式缓存系统,提升大型系统的响应速度与可靠性。

59

2026.01.09

热门下载

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

精品课程

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

共48课时 | 6.8万人学习

Git 教程
Git 教程

共21课时 | 2.5万人学习

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

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