讲师中心 微信公众号
AI工具推荐 视频效率加速

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

胖浩姑娘_3628

胖浩姑娘_3628

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

|

323人浏览过

|

来源于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.tour 或 auth-flow.tour。

快速创建第一个导览

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

YiHui GITHUB MONITOR
YiHui GITHUB MONITOR

监控多个 GitHub 仓库,配置发布、PR 与安全告警策略,通过定时 cron 任务推送低噪声通知。

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

运行与分享导览

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

  • 导览文件是纯 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 的价值不在炫技,而在把“口头说一遍”的引导,变成可复现、可迭代、可沉淀的轻量交互资产。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

292

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

500

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

351

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

266

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

578

2026.06.16

json数据格式
json数据格式

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

2095

2023.08.07

json是什么
json是什么

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

3162

2023.08.23

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

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

1056

2023.10.13

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

0

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn