0

0

VSCode的CodeTour插件:用代码导览来介绍你的项目

P粉986688829

P粉986688829

发布时间:2026-01-08 19:05:02

|

228人浏览过

|

来源于php中文网

原创

CodeTour插件可创建交互式项目导览:先安装插件,再新建.tour文件,支持跨文件跳转、代码块嵌入与行高亮,导览文件以相对路径保存于.vscode/codetours/并可提交Git共享。

vscode的codetour插件:用代码导览来介绍你的项目

如果您希望向团队成员或新加入的开发者清晰展示项目结构与核心逻辑,VSCode 的 CodeTour 插件可帮助您创建交互式、可执行的代码导览路径。以下是使用该插件构建项目介绍导览的具体操作方式:

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

一、安装并启用CodeTour插件

CodeTour 是一个由微软官方维护的开源扩展,需先在 VSCode 扩展市场中安装,之后才能创建和播放导览。该插件依赖 VSCode 的活动工作区与已打开的文件上下文,确保项目根目录已正确加载。

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

2、在搜索框中输入 CodeTour,找到由 Microsoft 发布的官方插件。

3、点击“安装”,安装完成后点击“重新加载”按钮使插件生效。

二、创建首个代码导览

导览以 JSON 文件形式保存在项目根目录下的 .vscode/codetours/ 子目录中,每个导览对应一个独立的 .tour 文件,支持多步骤、跨文件跳转与注释嵌入。

1、在 VSCode 中打开任意一个源码文件,例如 src/main.ts

2、按下快捷键 Cmd+Shift+P,调出命令面板,输入并选择 CodeTour: Start New Tour

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

4、此时编辑器右上角将出现浮动控件,点击“添加步骤”按钮,在当前光标位置插入第一条导览步骤,并填写说明文字。

三、添加跨文件导览步骤

真实项目介绍常需引导用户从入口文件跳转至配置、服务、组件等不同模块,CodeTour 支持显式指定目标文件路径与行号,实现精准导航。

jQuery单页全屏垂直滚动特效代码
jQuery单页全屏垂直滚动特效代码

非常实用的jQuery单页全屏垂直滚动特效代码,如今非常流行的特效代码,常用于产品功能介绍或者项目简介,此款jQuery插件滚动还是比较流畅,有些插件需要页面滚动到位才能切换页面,此特效还是比较流畅的。插件强大的自定义参数功能,支持手机端触屏以及支持切换的速度,值得学习使用。

下载

1、在导览播放状态下,点击右上角“+”按钮,选择 Add Step to File...

2、在文件选择器中定位到 src/config/index.ts,回车确认。

3、在弹出的行号输入框中填入 5,表示将光标自动定位至该文件第 5 行。

4、输入该步骤的描述,例如 此处定义了全局 API 基础地址与超时配置

四、插入代码片段与高亮关键行

导览步骤支持内联代码块渲染与行范围高亮,便于聚焦关键逻辑,避免信息过载。该功能通过在步骤描述中使用特定 Markdown 语法触发。

1、在某一步骤的描述编辑框中,输入三重反引号包裹的代码块,例如:

const app = createApp(App);\napp.use(store);\napp.mount('#app');

2、在同一描述中,在代码块后追加行高亮指令:> Lines 2–3

3、保存导览后播放,VSCode 将自动高亮显示第 2 至第 3 行,并渲染上方代码块作为上下文参考。

五、导出与共享导览文件

导览文件本质是结构化 JSON,可直接提交至 Git 仓库,供其他协作者同步加载。导览不依赖本地路径硬编码,所有文件路径均为相对于工作区根目录的相对路径。

1、在资源管理器中展开 .vscode/codetours/ 目录,找到刚创建的 Project Overview.tour 文件。

2、右键该文件,选择 Reveal in Finder(macOS)或对应平台的文件定位选项。

3、将整个 .vscode/codetours/ 目录添加至 Git 跟踪,并执行 git add .vscode/codetours/git commit -m "chore: add project introduction tour"

相关专题

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

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

406

2023.08.07

json是什么
json是什么

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

532

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

php学习网站大全
php学习网站大全

精选多个优质PHP入门学习网站,涵盖教程、实战与文档,适合零基础到进阶开发者,助你高效掌握PHP编程。

0

2026.01.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号