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

简介

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

本指南中的示例使用 C#，但其他语言的工作方式类似。

有关详细信息，请参阅“IDE 中的 GitHub Copilot 代码建议”。

Prerequisites

•           **对 Copilot 的访问权限**。 要在 Visual Studio 内的 GitHub Copilot 中使用 GitHub Copilot，你需要通过 Copilot免费 获得有限访问权限，或者通过付费的 Copilot 计划获得完全访问权限。 请参阅“[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot)”。
  

•           **Visual Studio 的兼容版本**。 要在 Visual Studio 中使用 GitHub Copilot，必须安装 Visual Studio for Windows 版本 2022 17.8 或更高版本。 有关更多信息，请参阅 Microsoft 文档中的“[安装 Visual Studio](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio?ref_product=copilot&ref_type=engagement&ref_style=text)”。
  

•           **适用于 Visual Studio 的 GitHub Copilot 扩展**。 有关如何安装 Copilot 扩展的说明，请参阅 Microsoft 文档中的“[在 Visual Studio 中安装 GitHub Copilot](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states?ref_product=copilot&ref_type=engagement&ref_style=text)”。
  

•           **将 GitHub 帐户添加到 Visual Studio**。 请参阅 Microsoft 文档中的[将 GitHub 帐户添加到 Visual Studio 密钥链](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts?ref_product=copilot&ref_type=engagement&ref_style=text)。
  

获取代码建议

GitHub Copilot 会在你键入时提供编码建议。 例如，在一个 C# 文件中键入此函数签名：

int CalculateDaysBetweenDates(

int CalculateDaysBetweenDates(

GitHub Copilot 会自动以灰色文本建议整个函数正文。 要接受建议，请按 Tab。

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

using System.Xml.Linq;

var doc = XDocument.Load("index.xhml");

// find all images

using System.Xml.Linq;

var doc = XDocument.Load("index.xhml");

// find all images

GitHub Copilot 将建议函数的实现。 要接受建议，请按 Tab。

显示替代建议

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

例如，在一个 C# 文件中键入此函数签名：

int CalculateDaysBetweenDates(

int CalculateDaysBetweenDates(

GitHub Copilot 将向你显示建议。

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

或者，也可以按键盘上的 Alt+. （或 Alt+,），以显示替代建议。

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

获取注释建议

GitHub Copilot 可以通过分析你编写的代码并生成描述代码用途的注释来提供代码注释建议。 对于 Copilot免费 用户，注释建议会计入每月 Copilot 对话助手 使用量，而不是代码建议使用量。

注释建议支持以下语言：

• C#
• C++

启用注释建议

若要启用注释建议，需要在 Visual Studio 中配置注释样式。

对于 C++

1. 在 Visual Studio 的“工具”菜单中，单击“选项”********。
2. 在左侧面板中，单击“文本编辑器”****。
3. 单击 C++，然后单击 “代码样式”。
4. 在 “代码样式” 标题下，单击“ 常规”。
5. 在“Comments”下，从下拉列表中选择“Xml Doc Comments”****。
6. 选择“编写注释时在新行的开头插入现有注释风格”和“继续进行单行注释”****。 然后点击OK。
7. 在Options选项卡中的左侧面板中，单击GitHub。
8. 单击 “Copilot”，然后单击 “编辑器”。
9. 选择启用 AI 生成的描述，以在支持的语言中自动插入文档注释。

对于 C#

1. 在 Visual Studio 的“工具”菜单中，单击“选项”********。
2. 在左侧面板中，单击“ 语言”。
3. 单击 C#，然后单击 “更多设置”，然后单击 “高级”。
4. 在“注释”下，选择为 /// 生成 XML 文档注释、编写 // 注释时，请在新行的开头插入 // 和 编写 /**/ 注释时在新行开头插入 *。 然后点击OK。
5. 在Options选项卡中的左侧面板中，单击GitHub。
6. 单击 “Copilot”，然后单击 “编辑器”。
7. 选择启用 AI 生成的描述，以在支持的语言中自动插入文档注释。

使用注释建议

若要启动注释建议，请在要注释的代码之前键入编写代码所用的语言对应的标准注释起始符（例如 ///），然后等待建议显示。

要接受建议，请按 Tab。若要修改建议，请按 Alt+/。 若要拒绝建议，请按 Esc。

导航和接受 接下来的编辑建议

基于你正在进行的编辑，Copilot 将预测你接下来可能进行编辑的位置，并给出相应的补全建议。

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

装订线中的箭头表示有可用的编辑建议。 单击箭头以访问提供键盘快捷方式的编辑建议菜单。 如果编辑建议在当前编辑器视图之外，则箭头将向上或向下指，以指示下一条建议的位置。