0

0

VSCode Code Tour插件:创建代码导览教程

P粉986688829

P粉986688829

发布时间:2025-12-17 19:32:38

|

584人浏览过

|

来源于php中文网

原创

Code Tour 插件支持创建交互式代码导览教程,所有内容以 JSON 格式 .tour 文件保存于项目中,含 file、line、description 等字段,支持 Markdown、多行高亮、代码执行及离线分享。

vscode code tour插件:创建代码导览教程

VSCode 的 Code Tour 插件能帮你把代码变成可交互的导览教程,适合新人上手、团队知识沉淀或开源项目引导。它不依赖外部服务,所有内容以纯文本文件(.tour)保存在项目中,版本可控、开箱即用。

安装与基础配置

在 VSCode 扩展市场搜索 “Code Tour”,安装由 Microsoft 官方维护的插件(图标为蓝色指南针)。重启后,右键编辑器任意位置或命令面板(Ctrl+Shift+P)输入 Code Tour: Create Tour 即可新建一个 tour 文件。默认生成的 my-tour.tour 是 JSON 格式,含 steps 数组,每步指定文件路径、行号和说明文字。

写一个实用的导览步骤

每个 step 至少包含 filelinedescription。支持 Markdown 语法,可加代码块、链接或表情符号提升可读性。例如:

{
  "file": "src/main.ts",
  "line": 12,
  "description": "这里是应用入口。✅ `createApp()` 初始化 Vue 实例,注意传入的根组件是 `App.vue`"
}
  • 行号支持范围(如 "line": [5, 8]),高亮多行逻辑块
  • "before" / "after" 字段插入前置或后置提示,比如提醒先运行 npm install
  • "code": "console.log('test')" 可在当前上下文执行小段代码(需开启实验性功能)

启动与分享导览

打开 tour 文件,点击右上角 ▶ Play Tour 按钮,或按 Ctrl+Shift+P → Code Tour: Start Tour。VSCode 会自动跳转到对应文件和位置,聚焦代码并显示气泡说明。支持暂停、跳步、重播。导览过程完全离线,发给同事只需把 .tour 文件一起提交到 Git —— 他们装了插件就能直接播放。

Bika.ai
Bika.ai

打造您的AI智能体员工团队

下载

进阶技巧:复用与自动化

多个 tour 可按场景拆分,比如 setup.tourapi-flow.tourtesting.tour,再用 "include" 字段组合调用。也可以配合 GitHub Codespaces 或 Dev Containers,在环境初始化时自动触发 tour 播放。对于文档型项目,还能用脚本从 JSDoc 注释自动生成 tour 步骤(需简单解析逻辑)。

基本上就这些。Code Tour 不复杂但容易忽略——它不是幻灯片,而是嵌在代码里的“活文档”。写得好,比写 README 更让人愿意点开看。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

419

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

console接口是干嘛的
console接口是干嘛的

console接口是一种用于在计算机命令行或浏览器开发工具中输出信息的工具,提供了一种简单的方式来记录和查看应用程序的输出结果和调试信息。本专题为大家提供console接口相关的各种文章、以及下载和课程。

415

2023.08.08

console.log是什么
console.log是什么

console.log 是 javascript 函数,用于在浏览器控制台中输出信息,便于调试和故障排除。想了解更多console.log的相关内容,可以阅读本专题下面的文章。

507

2024.05.29

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

959

2026.01.21

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

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

724

2023.07.05

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

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

共42课时 | 7.4万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.5万人学习

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

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