在 Visual Studio Code 中开始使用 GitHub Copilot

1. 安装 Visual Studio Code 扩展

要使用 GitHub Copilot,首先需要安装 Visual Studio Code 扩展。

  1. 访问 Visual Studio Code Marketplace 上的GitHub Copilot 扩展页面并安装扩展。

  2. 打开 Visual Studio 代码。系统将提示您通过登录 GitHub 来授权扩展。

    sign-in

  3. 授权扩展后,您将返回到 Visual Studio Code。

如果您收到以下消息,则您尚未添加到 GitHub Copilot 技术预览版。技术预览对有限数量的测试人员开放。要加入候补名单,请访问copilot.github.com

not-in-preview

安装后,GitHub Copilot 图标应出现在 Visual Studio Code 窗口底部的状态面板中。

安装有问题?访问反馈论坛

2. 看到你的第一个建议

GitHub Copilot 为数十种语言和各种框架提供建议,但它特别适用于 Python、JavaScript、TypeScript、Ruby 和 Go。以下示例使用 JavaScript,但其他语言的工作方式类似。

  1. 创建一个新的 JavaScript (.js) 文件。

  2. 键入以下函数头:

    函数 calculateDaysBetweenDates 开始 结束 {
  3. GitHub Copilot 将自动以灰色文本建议整个函数体,如下所示。确切的建议可能会有所不同。

    completion

  4. Tab接受建议。

GitHub Copilot 将尝试匹配您的代码的上下文和样式。您可以根据自己的选择编辑建议的代码。

3. 选择替代建议

对于任何给定的输入,GitHub Copilot 可以提供多个建议。作为开发人员,您始终负责;您可以选择要使用的建议,也可以全部拒绝。

  1. 清除文件(或开始一个新文件),然后再次键入以下内容:

    函数 calculateDaysBetweenDates 开始 结束 {
  2. GitHub Copilot 将再次向您显示建议的完成。

  3. 而不是按Tab

    • 在 macOS 上,按Option (⌥) or Alt](或Option (⌥) or Alt[)。
    • 在 Windows 或 Linux 上,按Alt](或Alt[)。

    GitHub Copilot 将循环查看其他替代建议。

  4. 当您看到您喜欢的建议时,请按Tab接受它。

  5. 如果您不喜欢任何建议,请按Esc

您还可以将鼠标悬停在建议上以查看用于选择建议的 GitHub Copilot 命令面板。

command-palette

4. 获得更多建议

有时,您可能不想使用第一组建议中的任何一个。你可以要求 GitHub Copilot 返回更多。

  1. 清除文件(或开始一个新文件),然后再次键入以下内容:

    函数 calculateDaysBetweenDates 开始 结束 {
  2. GitHub Copilot 将再次向您显示建议的完成。

  3. CtrlEnter。GitHub Copilot 将打开一个新选项卡并建议多个选项,如下所示。

    completions-pane

  4. 选择您喜欢的建议,然后单击“接受解决方案”继续。

  5. 如果您不喜欢任何返回的建议,只需关闭建议选项卡。

5. 从评论生成代码

GitHub Copilot 可以比大多数代码助手理解更多的上下文,并且可以从像评论这样简单的东西生成整个函数。

  1. 创建一个新的 JavaScript 文件,然后键入以下内容:

    // 查找所有没有替代文本的图像
    // 并给它们一个红色边框
    函数 process ( )  {
  2. GitHub Copilot 会自动建议一个实现:

    code-from-comment

6. 使用框架

GitHub Copilot 对于使用您不熟悉的 API 和框架特别有用。在这里,我们将使用 GitHub Copilot 创建一个返回当前时间的简单 Express 服务器。

  1. 创建一个新的 JavaScript 文件,键入以下注释,然后按Enter

    // Express 服务器在 3000 端口
  2. GitHub Copilot 将生成代码行来创建 Express 应用程序。按TabthenEnter接受每一行。

  3. 输入以下评论并按Enter

    // 返回当前时间
  4. GitHub Copilot 将为默认处理程序生成代码。按Tab接受每一行。

7. 更多示例

GitHub Copilot 可以做得更多。查看copilot.github.com上的示例以了解更多信息.

8. 键盘快捷键

下面列出了与 GitHub Copilot 相关的最常见的键盘快捷键。如果您想重新绑定它们,请查看配置指南

  • 接受内联建议:Tab

  • 忽略内联建议:Esc

  • 显示下一个内联建议:Alt + ]Option (⌥) + ]

  • 显示上一个内联建议:Alt + [Option (⌥) + [

  • 触发内联建议:Alt + \Option (⌥) + \.

  • 打开 Copilot(单独窗格中的 10 条建议)Ctrl + Enter:.

9. 启用和禁用 GitHub Copilot

Visual Studio Code 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。启用时其背景为蓝色,禁用时为红色。要启用或禁用 GitHub Copilot,请单击该图标。系统将询问您是希望切换当前文件类型还是全局切换。

github_copilot_status_icon

THE END