关于ide:微软开发的神器来感受一下神奇的代码之旅

89次阅读

共计 1978 个字符,预计需要花费 5 分钟才能阅读完成。

【导语】: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 树视图中查找编辑 / 删除步骤。

工作区

在录制时,零碎会要求抉择要将 tour 文件保留到的文件夹。这是必要的,因为 tour 作为文件写入工作区,须要明确 tour 应保留到哪个文件夹。

步骤题目

默认状况下,CodeTour 树应用以下显示名称格局显示每个旅行步骤:

# 步骤 - 文件名
#<stepNumber> - <filePath>

如果想给步骤一个更敌对 / 更容易辨认的名称,能够应用以下办法之一:

  1. 右键单击 CodeTour 树中的步骤并抉择 Change Title
  2. 反对 Markdown 语法,能够应用任何题目级别。例如,如果增加一个形容以 ### Activation 结尾的步骤,步骤和树视图将如下所示:

抉择文本

默认状况下,每个步骤都与创立正文的代码行相关联,然而,如果想调出特定范畴的代码作为步骤的一部分,只需在增加步骤之前突出显示代码(单击 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

  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 等。

正文完
 0