VSCode如何使用CodeTour代码导览_VSCode CodeTour代码导览使用指南

浅丽君_8672

浅丽君_8672

2026-04-06

407人浏览

原创

codetour 是将代码上下文转化为可播放、可分享、可版本控制的交互路径的工具;需在项目根目录 .tours/ 下创建 .tour.json 文件,路径须为小写相对路径,行号从1起,多行用 range,命令嵌入需以 >> 开头独占一行,且依赖插件、git 提交 .tours/ 目录及静态源码路径。

vscode如何使用codetour代码导览_vscode codetour代码导览使用指南

CodeTour 不是“看文档”的替代品,而是把代码上下文变成可播放、可分享、可版本控制的交互路径——只要路径写对、文件存在、行号有效,导览就能跑起来。

如何快速创建并保存第一个 .tour 文件

CodeTour 默认把导览存为 JSON 文件,路径固定在项目根目录下的 .tours/ 子目录中(不是 .vscode/,也不是随意位置)。命名后缀是 .tour.json,比如你起名 setup-flow,最终生成的就是 .tours/setup-flow.tour.json。

  • 必须先打开一个源码文件(哪怕只是空的 index.ts),否则 CodeTour: Start New Tour 命令会灰掉
  • 命令面板里输入 CodeTour: Start New Tour(不是 Record Tour,后者是旧版或混淆项)
  • 输入名称后回车,此时编辑器右下角会出现 Tour 状态栏,但还没任何步骤——得手动加
  • 光标停在某行,右键 → CodeTour: Add Step to Current Tour,填描述再回车才算真正落盘
  • 别忘了点右下角软盘图标 Save Tour,否则关窗口就丢步骤

跨文件跳转时路径和行号怎么写才不报错

导览能跨文件,但路径必须是相对于项目根目录的**相对路径**,且文件必须真实存在。VS Code 不会帮你创建不存在的文件,也不会自动修正拼错的路径。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 错误写法:"file": "src/config/index.ts" —— 如果项目没 src/config/index.ts,播放时直接卡住,无提示
  • 正确写法:"file": "src/config/index.ts"(小写、斜杠方向一致、无多余空格)
  • 行号从 1 开始计数,"line": 0 或负数会被忽略,"line": 999 超出文件长度则跳到末尾
  • 想高亮多行?用 "range": [12, 15](表示第 12–15 行),不是 "line": 12 + 手动拖选
  • 路径区分大小写:macOS/Linux 下 Src/ ≠ src/,Windows 虽不敏感但建议统一小写避免协作问题

导览里执行命令(如 npm run dev)为什么点不动

CodeTour 支持在步骤描述中嵌入可点击命令,但格式非常严格:必须以 >> 开头,且独占一行,后面紧跟完整 shell 命令。

  • 有效写法:
    >> npm run dev
    或
    >> git status
  • 无效写法:
    运行 >> npm run dev
    (带前缀文字)、
    >>npm run dev
    (>> 和命令间无空格)、
    >> npm run dev && echo done
    (含 && 会截断)
  • 命令在当前工作区根目录下执行,不是在步骤所在文件目录
  • 权限问题常见:Windows 上若启用了 PowerShell 执行策略限制,>> npm 可能静默失败,建议改用 >> cmd /c npm run dev

导览文件提交 Git 后别人打不开?检查这三点

导览本质是 JSON 配置,但依赖三个隐性条件才能复现:工作区结构、VS Code 版本、CodeTour 插件状态。缺一不可。

  • 确认对方也装了 CodeTour 插件(v0.19+ 推荐,老版本不支持 range 或命令执行)
  • .tours/ 目录要进 Git,但别把 .tours/*.tour.json 加进 .gitignore —— 这是最常被忽略的点
  • 如果导览里引用了 node_modules/ 下的文件,或临时生成的 dist/,别人拉代码后这些路径不存在,播放必然失败

最稳妥的做法:所有导览只绑定项目源码(src/、lib/、config/),避开构建产物和依赖目录。路径越“静态”,越容易跨环境复现。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.08.07

2155

5

json是什么
json是什么

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

2023.08.23

3322

1

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

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

2023.10.13

1116

3

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

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

2025.09.10

3819

7

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

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

2023.07.05

6479

9

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

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

2023.07.06

1860

6

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

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

2023.07.24

1094

5

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

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

2024.04.09

4217

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3981

6

热门下载

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

精品课程

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