使用 GitHub Copilot 在 IDE 中获取代码建议

关于 GitHub Copilot 和 Visual Studio Code

本指南将演示如何从 Visual Studio Code 中的 GitHub Copilot 获取编码建议。 要查看其他常用编码环境的说明，请使用页面顶部的工具切换器。

VS Code 中的 Copilot 提供两种建议：

• 代码补全****。 Copilot 会在你键入时提供编码建议。 也可以在注释内使用自然语言描述要执行的操作，GitHub Copilot 会提供代码建议以实现你的目标。
• 下一个编辑建议 (公共预览版)。**** 基于你正在进行的编辑，Copilot 将预测你接下来可能进行编辑的位置，并给出相应的补全建议。

本指南中的示例使用 JavaScript，但其他语言的工作方式类似。 GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询，生成 API 和框架的建议，并可以帮助开发基础结构即代码。

先决条件

• 对 Copilot 的访问权限****。 若要在 Visual Studio Code 中使用 GitHub Copilot，需要活动的 Copilot 订阅（例如 Copilot Pro、Copilot Enterprise 或 Copilot Business）或通过 Copilot Free 进行访问，这提供有限的功能。 有关如何访问 Copilot 的信息，请参阅“什么是 GitHub Copilot？”。

• Visual Studio Code。 若要在 Visual Studio Code 中使用 GitHub Copilot，必须安装 Visual Studio Code。 有关详细信息，请参阅 Visual Studio Code 下载页面。

• Visual Studio Code 中的 Copilot****。 当你首次在 Visual Studio Code 中设置 GitHub Copilot 时，所需的扩展会自动安装。 无需手动下载或安装它们。 有关详细说明，请参阅 Visual Studio Code 文档中的在 Visual Studio Code 中设置 GitHub Copilot。

获取代码建议

GitHub Copilot 会在你键入时提供编码建议。 例如，在一个 JavaScript 文件中键入此函数标头：

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 会自动建议函数的剩余部分。 要接受建议，请按 Tab。

也可以在注释内使用自然语言描述要执行的操作，GitHub Copilot 会提供代码建议以实现你的目标。 例如，在一个 JavaScript 文件中键入此注释：

// write a function to
// find all images without alternate text
// and give them a red border

// write a function to
// find all images without alternate text
// and give them a red border

GitHub Copilot 会自动提供代码建议。 要接受建议，请按 Tab。

显示替代建议

对于任何给定的输入，GitHub Copilot 可以提供多个建议。 可以选择要使用的建议，或拒绝所有建议。

例如，在一个 JavaScript 文件中键入此函数标头，然后按 Enter：

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 将向你显示建议。

现在，将鼠标悬停在建议上方，以显示用来选择建议的 GitHub Copilot 控件。 要显示下一批或上一批建议，请单击控件中的向前或向后箭头按钮。

也可以使用键盘快捷方式显示替代建议：

要接受建议，请单击 Copilot 命令面板中的“接受”，或按 Tab。要拒绝所有建议，请按 Esc。

在新选项卡中显示多个建议

如果不想使用 GitHub Copilot 提供的任何初始建议，可以在新选项卡中显示多个建议。

例如，在一个 JavaScript 文件中键入此函数标头，然后按 Enter：

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 将向你显示建议。 现在，按 Ctrl+Enter，以打开具有多个其他选项的新选项卡。

要接受建议，请单击建议下方的“接受建议编号”。 若要拒绝所有建议，请关闭选项卡。

接受部分建议

如果不想接受 GitHub Copilot 的完整建议，可以接受下一个单词或下一行建议。

例如，在一个 JavaScript 文件中键入此函数标头，然后按 Enter：

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 会自动以灰色文本建议整个函数正文。 具体的建议可能会有所不同。

现在，将鼠标悬停在建议上方，以显示用来选择建议的 GitHub Copilot 控件。 要只接受建议的下一个单词，请单击控件中的“接受单词”。****

或者，也可以使用键盘快捷方式接受建议的下一个单词：

如果希望接受下一行建议，则需要为命令 editor.action.inlineSuggest.acceptNextLine 设置自定义键盘快捷方式。 有关设置自定义键盘快捷键的详细信息，请参阅“在环境中配置 GitHub Copilot”。

关于 下一个编辑建议

内联建议可自动补全代码，但许多开发任务涉及编辑现有代码。 下一个编辑建议 可协助在光标位置以及代码其他相关部分进行编辑，有助于保持一致性并简化更改。

下一个编辑建议 根据正在进行的更改预测可能需要在何处进行何种编辑。 建议可能涵盖单个符号、整行或多行，具体取决于潜在更改的范围。

要启用 下一个编辑建议，请参阅 在环境中配置 GitHub Copilot。

浏览和接受建议

可以使用 Tab 浏览建议的代码更改，从而更轻松地找到下一个相关编辑，而无需手动搜索文件或引用。 再次按 Tab 可接受建议。

编辑器边栏中的箭头表示有可用的编辑建议。 将鼠标悬停在箭头上方，以访问编辑建议菜单，该菜单提供键盘快捷键和设置选项。 如果编辑建议在当前编辑器视图之外，箭头将向上或向下指，以指示下一条建议的位置。

有关更多详细信息和示例，请参阅 Visual Studio Code 文档中的在 VS Code 中使用 GitHub Copilot 进行代码补全。