微软开发的神器,来感受一下神奇的代码之旅

【导语】:CodeTour(代码之旅)是微软官方开发的 VS Code 扩展,允许记录和回放代码的演练和思路。

简介

CodeTour 是一个 VS Code 插件,允许记录和回放代码库的演练和思路。我们通常都是通过代码注释或者文档来解释某段代码或方法的功能及逻辑,这样的方法相对简便,但是对阅读的人来说还不够友好,CodeTour 允许我们为代码添加备注,并且将这些备注串联起来,动态地展示我们的思路以及代码逻辑。

就像一个目录,可以轻松地加入到新的项目/功能,并且可视化错误报告或了解代码审查/PR 更改的上下文。"code tour"只是一系列交互步骤,每个步骤都与特定目录或文件/行进行关联,并包括对相应代码的描述。开发人员可以 clone 一个仓库,然后立即开始学习,而无需参考 CONTRIBUTING.md 文件或依赖他人的帮助。

此处为视频,戳链接: https://mp.weixin.qq.com/s/55...

VSCode 地址:

https://marketplace.visualstu...

项目地址:

https://github.com/microsoft/...

入门

录制

单击树视图中的 + 按钮 CodeTour(如果它可见)或运行 CodeTour: Record Tour 命令。这将启动 CodeTour,这时候我们可以开始打开文件,单击要注释的行的“注释栏”,然后添加相应的描述。添加任意数量的步骤,完成后,单击停止。

录制时,CodeTour 树状视图将显示当前录制的预览,以及当前的一组步骤。可以知道当前正在进行哪个 tour 的录制。

此处为视频,戳链接: https://mp.weixin.qq.com/s/55...

如果需要在录制时编辑或删除步骤,单击 ... 步骤描述旁边的菜单,然后选择适当的操作,也可以从 CodeTour 树视图中查找编辑/删除步骤。

微软开发的神器,来感受一下神奇的代码之旅_第1张图片

工作区

在录制时,系统会要求选择要将 tour 文件保存到的文件夹。这是必要的,因为 tour 作为文件写入工作区,需要明确 tour 应保存到哪个文件夹。

步骤标题

默认情况下,CodeTour 树使用以下显示名称格式显示每个游览步骤:

# 步骤-文件名
# - 

如果想给步骤一个更友好/更容易识别的名称,可以使用以下方法之一:

  1. 右键单击 CodeTour 树中的步骤并选择 Change Title
  2. 支持 Markdown 语法,可以使用任何标题级别。例如,如果添加一个描述以 ### Activation 开头的步骤,步骤和树视图将如下所示:

微软开发的神器,来感受一下神奇的代码之旅_第2张图片

选择文本

默认情况下,每个步骤都与创建注释的代码行相关联,但是,如果想调出特定范围的代码作为步骤的一部分,只需在添加步骤之前突出显示代码(单击 Add Tour to Step 按钮),所选内容将作为步骤的一部分被捕获。

此处为视频,戳链接: https://mp.weixin.qq.com/s/55...

调整录制步骤

在录制时,添加的每个新步骤都将附加到录制的末尾,可以通过执行以下操作之一按顺序上下移动现有步骤:

  • 将鼠标悬停在 CodeTour 树中的步骤上,然后单击向上/向下箭头图标
  • 右键单击 CodeTour 树中的步骤并选择 Move Up 或 Move Down 菜单项
  • 单击 ... 步骤注释 UI 中的菜单,然后选择 Move Up 或 Move Down

如果想在录制中间添加一个新步骤,只需导航到要在其后插入新步骤。

代码块

可以将 Markdown 代码块添加到步骤的正文内容,则 CodeTour 播放器将 Insert Code 在其下方呈现一个链接,该链接允许查看器自动将代码片段插入当前文件中与步骤关联的行,使得 CodeTour 创建交互式教程或示例变得容易。

此处为视频,戳链接: https://mp.weixin.qq.com/s/55...

Shell 命令

为了更简单地将 shell 命令嵌入到一个步骤中(例如执行构建、运行测试、启动应用程序),CodeTour 支持一个特殊的 >> 符号,在后面紧跟想要运行的 shell 命令(例如 >> npm run compile)。这将被转换为一个超链接,当点击该链接时,将启动一个新的集成终端并运行指定的命令。

此处为视频,戳链接: https://mp.weixin.qq.com/s/55...

开启 Tour

要开始预览,只需打开包含一个或多个 tour 的代码库。通过以下任意一种方法都可以开始一个 tour:

  1. 在活动选项卡的 CodeTour 视图中选择 Explorer

微软开发的神器,来感受一下神奇的代码之旅_第3张图片

  1. 运行CodeTour: Start Tour 命令,然后选择想启用的 tour
此处为视频,戳链接: https://mp.weixin.qq.com/s/55...
开源前哨 日常分享热门、有趣和实用的开源项目。参与维护 10万+ Star 的开源技术资源库,包括:Python、Java、C/C++、Go、JS、CSS、Node.js、PHP、.NET 等。

你可能感兴趣的