0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

微软官方开发的VS Code扩展介绍

数据分析与开发 来源:开源前哨 作者:小秋 2021-10-22 17:13 1928次阅读

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

简介

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

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

入门

录制

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

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

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

工作区

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

步骤标题

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

# 步骤-文件名#《stepNumber》 - 《filePath》

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

右键单击 CodeTour 树中的步骤并选择 Change Title

支持 Markdown 语法,可以使用任何标题级别。例如,如果添加一个描述以 ### Activation 开头的步骤,步骤和树视图将如下所示:

选择文本

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

调整录制步骤

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

将鼠标悬停在 CodeTour 树中的步骤上,然后单击向上/向下箭头图标

右键单击 CodeTour 树中的步骤并选择 Move Up 或 Move Down 菜单项

单击 。.. 步骤注释 UI 中的菜单,然后选择 Move Up 或 Move Down

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

代码块

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

Shell 命令

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

开启 Tour

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

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

2. 运行CodeTour: Start Tour 命令,然后选择想启用的 tour

责任编辑:haq

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 微软
    +关注

    关注

    4

    文章

    6614

    浏览量

    104193
  • 代码
    +关注

    关注

    30

    文章

    4803

    浏览量

    68774

原文标题:微软开发的神器,来感受一下神奇的代码之旅

文章出处:【微信号:DBDevs,微信公众号:数据分析与开发】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    相关推荐

    使用MCUXpresso for VS Code插件开发Zephyr的hello world

    本期来到Zephyr实战经验演练,小编带着大家一起使用MCUXpresso for VS Code插件来开发一个属于Zephyr的hello world。
    的头像 发表于 01-03 09:21 496次阅读
    使用MCUXpresso for <b class='flag-5'>VS</b> <b class='flag-5'>Code</b>插件<b class='flag-5'>开发</b>Zephyr的hello world

    Zephyr领进门系列:MCUXPresso for VS Code插件安装

    一套PC端的Zephyr OS开发环境。话不多说,开整! 1.  安装VS Code 相信不少小伙伴已经将VS Code当作装机必备工具了,
    的头像 发表于 12-19 09:53 1071次阅读
    Zephyr领进门系列:MCUXPresso for <b class='flag-5'>VS</b> <b class='flag-5'>Code</b>插件安装

    基于微软专利的带蝴蝶出瞳扩展的光波导结构

    到出射耦合的传播过程中分割视场的系统。一个非常流行的方法是所谓的 \"蝴蝶出瞳扩展\",即在FOV的正负部分使用两个独立的EPE光栅区域,这也被应用于微软的Hololens2。在这
    发表于 12-11 11:36

    IAR升级VS Code调试扩展,引入Listwindow技术

    IAR近日宣布对VS Code中的调试扩展IAR C-SPY调试器进行了重要升级。此次升级的核心亮点在于引入了IAR独有的Listwindow技术,为嵌入式设备调试设立了新的标杆
    的头像 发表于 12-11 11:15 293次阅读

    ​IAR C-SPY为VS Code社区树立调试新标准

    全球领先的嵌入式系统开发软件解决方案供应商IAR宣布,对VS Code中的调试扩展IAR C-SPY调试器进行了重大升级。此次升级引入了IAR的Listwindow技术,进一步提升了调
    的头像 发表于 12-06 10:27 226次阅读

    RHEL即将成为微软WSL的官方Linux发行版

    红帽和微软共同宣布, Red Hat Enterprise Linux(RHEL)即将成为微软 Windows Subsystem for Linux(WSL)的官方 Linux 发行版 。 “对于
    的头像 发表于 11-26 11:03 359次阅读

    Vector推出一套基于Visual Studio Code的免费插件

    在汽车软件开发过程中,除使用MATLAB开发算法外,专业开发者也偏向使用Visual Studio Code开发代码,其中软件测试用例的编
    的头像 发表于 11-24 14:15 469次阅读
    Vector推出一套基于Visual Studio <b class='flag-5'>Code</b>的免费插件

    诺基亚扩展微软Azure的数据中心网络供应协议

    的进一步巩固。 作为协议扩展的重要组成部分,诺基亚将向微软Azure提供其最新的7250 IXR-10e平台。该平台以其卓越的性能、灵活性和可扩展性,在数据中心网络中发挥着关键作用。通过提供这一先进平台,诺基亚旨在助力
    的头像 发表于 11-22 13:53 205次阅读

    【AG32开发板体验连载】网络摄像头

    程序员、搞算法的必备) 3、VS Code 里安装 PlatformIO IDE 4、VS Code Platform 里安装 AGM 的脚本 具体可以看
    发表于 10-11 14:54

    树莓派gui开发用什么ide

    )。以下是一些常见的IDE及其特点: Visual Studio Code (VS Code) 简介 :VS Code 是一款轻量级但功能强
    的头像 发表于 08-30 16:49 955次阅读

    Microchip发布面向VS Code的MPLAB扩展早期体验版本

    (MPLAB Extensions)早期体验版本。此次发布为嵌入式设计人员提供了将项目从MPLAB X集成开发环境(IDE)导入VS Code的工具,同时仍可使用Microchip的调试和编程支持。这一举措是Microchip长
    的头像 发表于 08-28 10:01 640次阅读

    芯海 32 位 MCU 开发调试 ,基于 VS Code 插件实现芯海 32 位 MCU 开发调试

    编译器命令行参数、GCC 链 接脚本、JLink 配置等,而且在推广和移植时也会遇到比较多的问题。因此我们开发了基于 VS Code 的插件,目的是统一开发工具、简化用户操作、提高
    发表于 05-16 10:46

    微软推出游戏开发扩展新程序Microsoft Game Dev

    官方描述,扩展版的功能包括向Dev Home设备配置工具推荐适合游戏开发的套装,同时增加对控制台屏幕中央的游戏开发小部件的支持。值得注意的是,仅Windows 11和Windows
    的头像 发表于 03-21 10:24 607次阅读

    VS CodeVS Codium之间的区别有哪些?你选哪个?

    VS Codium 是一个 VS Code 的克隆版本,百分之百免费且开源。
    的头像 发表于 02-23 15:28 1896次阅读
    <b class='flag-5'>VS</b> <b class='flag-5'>Code</b>和<b class='flag-5'>VS</b> Codium之间的区别有哪些?你选哪个?

    Simplicity Studio 5扩增功能支持以VS Code开发

    应用程序开发的支持。此一功能扩展可让开发人员在VSCode生态系统中构建、刷新和调试。用户可以使用VS Code作为主要的IDE,同时仍然能
    的头像 发表于 01-29 10:34 1038次阅读
    Simplicity Studio 5扩增功能支持以<b class='flag-5'>VS</b> <b class='flag-5'>Code</b><b class='flag-5'>开发</b>