Skip to main content

在 Visual Studio Code 中配置 GitHub Copilot

可以在 Visual Studio Code 中启用、配置和禁用 GitHub Copilot。

GitHub Copilot 可用于个人帐户位于 GitHub.com 上的 GitHub 客户。 Managed user accounts 不能使用 GitHub Copilot。

GitHub Copilot 供经过验证的学生、教师和热门开源项目的维护人员免费使用。 如果你不是学生、教师或热门开源项目的维护人员,可以在一次性 60 天试用版中免费试用 GitHub Copilot。 免费试用后,需要付费订阅才能继续使用。 有关详细信息,请参阅“关于 GitHub Copilot 的计费”。

关于 Visual Studio Code 中的 GitHub Copilot

如果使用 Visual Studio Code,GitHub Copilot 可以在你键入时自动完成代码。 安装完成后,可以启用或禁用 GitHub Copilot,并且可以在 Visual Studio Code 或 GitHub.com 上配置高级设置。

先决条件

若要在 Visual Studio Code 中配置 GitHub Copilot,必须安装 GitHub Copilot 插件。 有关详细信息,请参阅“Visual Studio Code 中的 GitHub Copilot 入门指南”。

GitHub Copilot 的键盘快捷方式

使用 GitHub Copilot 时,可使用 Visual Studio Code 中的默认键盘快捷方式。 也可使用每个特定命令的首选键盘快捷方式在键盘快捷方式编辑器中重新绑定快捷方式。 可以在键盘快捷方式编辑器中按命令名称搜索每个键盘快捷方式。

操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Option (⌥)+]
editor.action.inlineSuggest.showNext
显示上一个内联建议Option (⌥)+[
editor.action.inlineSuggest.showPrevious
触发内联建议Option (⌥)+\
editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Returngithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot
操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Alt+]editor.action.inlineSuggest.showNext
显示上一个内联建议Alt+[editor.action.inlineSuggest.showPrevious
触发内联建议Alt+\editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Entergithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot
操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Alt+]editor.action.inlineSuggest.showNext
显示上一个内联建议Alt+[editor.action.inlineSuggest.showPrevious
触发内联建议Alt+\editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Entergithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot

重新绑定键盘快捷方式

如果不想在使用 GitHub Copilot 时使用 Visual Studio Code 中的默认键盘快捷方式,可使用每个特定命令的首选键盘快捷方式在键盘快捷方式编辑器中重新绑定快捷方式。

  1. 依次单击“文件”菜单、“首选项”和“键盘快捷方式” 。 Visual Studio Code 键盘快捷方式的屏幕截图
  2. 在“键盘快捷方式”编辑器中,搜索要更改的键盘快捷方式的命令名称。 键盘快捷方式搜索栏的屏幕截图
  3. 在要更改的命令旁边,单击铅笔图标。 键盘快捷方式编辑器的屏幕截图
  4. 键入要用于命令的按键,然后按 Enter/Return“编辑键盘快捷方式”文本框的屏幕截图

启用或禁用 GitHub Copilot

可以在 Visual Studio Code 中启用或禁用 GitHub Copilot。 Visual Studio Code 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。 启用后,图标的背景色将与状态栏颜色相匹配。 禁用后,图标的背景色将与状态栏颜色形成对比。

  1. 若要启用或禁用 GitHub Copilot,请单击 Visual Studio Code 窗口底部面板中的状态图标。 Visual Studio Code 中状态图标的屏幕截图

  2. 如果要禁用 GitHub Copilot,系统会询问是全局禁用建议,还是要禁用当前正在编辑的文件的语言。

    • 若要全局禁用 GitHub Copilot 的建议,请单击“全局禁用”。
    • 若要禁用指定语言的 GitHub Copilot 的建议,请单击“对 禁用”。 全局或为当前语言禁用 GitHub Copilot 的选项的屏幕截图

启用或禁用内联建议

可以选择在 Visual Studio Code 中启用或禁用 GitHub Copilot 的内联建议。

  1. 在“文件”菜单中,导航到“首选项”,然后单击“设置” 。 Visual Studio Code 设置的屏幕截图
  2. 在“设置”选项卡的左侧面板中,单击“扩展”,然后选择“Copilot” 。
  3. 在“内联建议: 启用”下,选中或取消选中该复选框以启用或禁用内联建议。

启用或禁用特定语言的 GitHub Copilot

可以指定要为其启用或禁用 GitHub Copilot 的语言。

  1. 在 Visual Studio Code 中,单击“扩展”选项卡,然后导航到“Copilot”部分 。 有关详细信息,请参阅“启用和禁用内联建议”。

  2. 在“启用或禁用指定语言的 Copilot”下,单击“在 settings.json 中进行编辑”。

  3. 在 settings.json 文件中,添加或删除要为其启用或禁用 GitHub Copilot 的语言。 例如,要在 GitHub Copilot 中启用 Python,请将 "python": true 添加到列表中,确保除了最后一个列表项之外还有一个尾随逗号。

    {
        "editor.inlineSuggest.enabled": true,
        "github.copilot.enable": {
            "*": true,
            "yaml": false,
            "plaintext": false,
            "markdown": true,
            "javascript": true,
            "python": true
        }
    }
    

在 GitHub.com 上配置 GitHub Copilot 设置

在拥有处于活动状态的 GitHub Copilot 试用版或订阅后,可以在 GitHub 上的 GitHub Copilot 设置中为你的个人帐户调整 GitHub Copilot 设置。 无论在何处使用 GitHub Copilot,这些设置都适用。 可以配置 GitHub Copilot 提供的建议,以及 GitHub 使用你的遥测数据的方式。

启用或禁用重复检测

GitHub Copilot 包含筛选器,该筛选器用于检测与 GitHub 上的公共代码匹配的代码建议。 可以选择启用或禁用筛选器。 启用筛选器后,GitHub Copilot 会根据 GitHub 上的公共代码检查代码建议及其周围约 150 个字符的代码。 如果存在匹配或接近匹配,不会向你显示建议。

  1. 在任何页面的右上角,单击个人资料照片,然后单击“设置”。

    用户栏中的 Settings 图标 1. 在左侧边栏中,单击“ GitHub Copilot”。

  2. 在“与公共代码匹配的建议”下,选择下拉菜单,然后单击“允许”以允许与公共代码匹配的建议,或单击“阻止”以阻止与公共代码匹配的建议 。 重复检测选项的屏幕截图 1. 要确认新设置,请单击“保存”。

启用或禁用遥测

通过调整你的用户设置,你可以选择代码片段是否由 GitHub 收集和保留,并进一步通过 Microsoft 和 OpenAI 进行处理和共享。 有关 GitHub Copilot 可能根据你的遥测设置收集的数据的更多信息,请参阅“GitHub 附加产品和功能条款”以及“GitHub Copilot 隐私常见问题解答”

  1. 在任何页面的右上角,单击个人资料照片,然后单击“设置”。

    用户栏中的 Settings 图标 1. 在左侧边栏中,单击“ GitHub Copilot”。

  2. 若要允许或阻止 GitHub 使用你的遥测数据,请选择或取消选择“允许 GitHub 使用我的代码片段进行产品改进”。 遥测选项的屏幕截图 1. 要确认新设置,请单击“保存”。

延伸阅读