开始使用 GitHub Copilot

本文内容

可以通过在首选的环境中安装扩展来开始使用 GitHub Copilot。

GitHub Copilot 可以通过具有 GitHub Copilot Individual 的个人帐户或通过具有 GitHub Copilot Business 的组织帐户进行管理。

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

尝试 GitHub Copilot

关于 GitHub Copilot 和 JetBrains IDE

GitHub Copilot 在编写代码时提供 AI 对程序员的自动完成样式的建议。 有关详细信息，请参阅“关于 GitHub Copilot Individual”。

如果使用 JetBrains IDE，可以直接在编辑器中查看并合并来自 GitHub Copilot 的建议。 本指南演示如何在适用于 macOS、Windows 或 Linux 的 JetBrains IDE 中使用 GitHub Copilot。

先决条件

  • 若要使用 GitHub Copilot，必须拥有有效的 GitHub Copilot 订阅。 有关详细信息，请参阅“关于 GitHub Copilot 的计费”。

  • 若要在 JetBrains 中使用 GitHub Copilot，必须安装兼容的 JetBrains IDE。 GitHub Copilot 与以下 IDE 兼容：

    • IntelliJ IDEA（旗舰版、社区版、教育版）
    • Android Studio
    • AppCode
    • CLion
    • Code With Me Guest
    • DataGrip
    • DataSpell
    • GoLand
    • JetBrains Client
    • MPS
    • PhpStorm
    • PyCharm（专业版、社区版、教育版）
    • Rider
    • RubyMine
    • RustRover
    • WebStorm

    有关详细信息，请参阅 JetBrains IDE 工具查找器。

在 JetBrains IDE 中安装 GitHub Copilot 插件

若要在 JetBrains IDE 中使用 GitHub Copilot，必须先安装 GitHub Copilot 扩展。 以下过程将指导你在 IntelliJ IDEA 中安装 GitHub Copilot 插件。 在另一个受支持的 IDE 中安装插件的步骤可能有所不同。

  1. 在 JetBrains IDE 中，在“文件”菜单 (Windows) 或 IDE 名称 (Mac) 下（例如 PyCharm 或 IntelliJ），单击“设置”。****************

  2. 在“设置”对话框的左侧菜单中，单击“插件”。********

  3. 在“设置”对话框顶部，单击“市场”。******** 在搜索栏中，搜索 copilot，然后单击“安装****”。

    “设置”窗口的屏幕截图。 标有“市场”的选项卡以橙色轮廓突出显示。 在搜索结果列表中，已安装的“GitHub Copilot”插件由选定的复选框标记。

  4. 安装 GitHub Copilot 后，单击“重启 IDE”。

  5. JetBrains IDE 重启后，单击“工具”菜单。 单击“GitHub Copilot”，然后单击“登录到 GitHub”。

    展开的“工具”菜单和“GitHub Copilot”子菜单的屏幕截图。 “登录到 GitHub”选项以蓝色突出显示。

  6. 在“登录到 GitHub”对话框中，若要复制设备代码并打开设备激活窗口，请单击“复制并打开”。

    “登录到 GitHub”对话框的屏幕截图。 设备代码显示在标记为“复制并打开”的按钮上方。

  7. 设备激活窗口将在浏览器中打开。 粘贴设备代码，然后单击“继续”。

  8. GitHub 将请求 GitHub Copilot 所需的权限。 若要批准这些权限，请单击“授权 GitHub Copilot 插件”。

  9. 权限获得批准后，JetBrains IDE 将显示确认。 要开始使用 GitHub Copilot，请单击“确定”。

查看第一个建议

注意：如果为 GitHub Copilot 启用了重复检测，则使用提供的代码示例时，可能会收到有限的建议或没有建议。 作为替代方法，你可以首先键入自己的代码，以查看来自 GitHub Copilot 的建议。 有关重复检测的详细信息，请参阅“在 GitHub.com 上配置 GitHub Copilot 设置”。

GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询。 以下示例使用的是 Java，但其他语言的工作方式类似。

  1. 在 JetBrains IDE 中，创建新的 Java (*.java) 文件。
  2. 在 Java 文件中，通过键入 class Test 创建类。 GitHub Copilot 将自动以灰色文本建议类正文。 具体的建议可能会有所不同。
  3. 要接受建议，请按 Tab。
  4. 若要提示 GitHub Copilot 建议函数正文，请在 main 函数括号下方键入以下行。 具体的建议可能会有所不同。
    Java
    int calculateDaysBetweenDates(
  5. 要接受建议，请按 Tab。

GitHub Copilot 将尝试与代码的上下文和样式匹配。 始终可以编辑建议的代码。

查看替代建议

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

  1. 在 JetBrains IDE 中，创建新的 Java (*.java) 文件。

  2. 若要提示 GitHub Copilot 显示建议，请在 Java 文件中键入以下行。

    Java
    int calculateDaysBetweenDates(

  3. （可选）如果有其他建议，可以选择查看。

    OS查看下一个建议查看上一个建议
    macOS选项+]选项+[
    WindowsAlt+]Alt+[
    LinuxAlt+]Alt+[

  4. 若要接受建议，请按 Tab。若要拒绝所有建议，请按 Esc。

在新选项卡中查看多个建议

你可能不想获得 GitHub Copilot 提供的任何初始建议。 可以使用键盘快捷方式来提示 GitHub Copilot 在新选项卡中显示多个建议。

  1. 在 JetBrains IDE 中，创建新的 Java (*.java) 文件。

  2. 若要提示 GitHub Copilot 显示建议，请在 Java 文件中键入以下行。

    Java
    int calculateDaysBetweenDates(

  3. 打开包含多个附加建议的新选项卡。

    • 在 macOS 上，按 Command+Shift+A，然后单击“打开 GitHub Copilot”，或按 Command+Shift+</kbd> 立即打开新选项卡。
    • 在 Windows 或 Linux 上，按 Ctrl+Enter，然后单击“打开 GitHub Copilot”。

  4. 若要接受建议，请在建议上方单击“接受解决方案”。 若要拒绝所有建议，请关闭选项卡。

从注释生成代码建议

可以在注释中使用自然语言描述要执行的操作，GitHub Copilot 会提供代码建议来实现你的目标。

  1. 在 JetBrains IDE 中，创建新的 Java (*.java) 文件。

  2. 若要提示 GitHub Copilot 以建议 Java 文件中函数的实现，请键入以下行。

    Java
    // find all images without alternate text
// and give them a red border
void process () {

启用或禁用 GitHub Copilot

可以为所有语言或单个语言启用或禁用 GitHub Copilot。 JetBrains IDE 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。 启用后，将突出显示图标。 禁用后，图标灰显。

  1. 若要启用或禁用 GitHub Copilot，请单击 JetBrains 窗口底部面板中的状态图标。

    IntelliJ IDEA 工具栏的屏幕截图。 GitHub Copilot 徽标以橙色轮廓突出显示。

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

    • 若要全局禁用 GitHub Copilot 的建议，请单击“禁用完成”。
    • 若要禁用指定语言的 GitHub Copilot 的建议，请单击“禁用 LANGUAGE 完成”。

    全局或为当前语言禁用 GitHub Copilot 的选项的屏幕截图。

关于 GitHub Copilot 和 Visual Studio

GitHub Copilot 在编写代码时提供 AI 对程序员的自动完成样式的建议。 有关详细信息，请参阅“关于 GitHub Copilot Individual”。

如果使用 Visual Studio，可以直接在编辑器中查看并合并来自 GitHub Copilot 的建议。 本指南演示如何在适用于 Windows 的 Visual Studio 中使用 GitHub Copilot。

先决条件

  • 若要使用 GitHub Copilot，必须拥有有效的 GitHub Copilot 订阅。 有关详细信息，请参阅“关于 GitHub Copilot 的计费”。

  • 要在 Visual Studio 中使用 GitHub Copilot，必须安装 Visual Studio 2022 17.6 或更高版本。 有关详细信息，请参阅 Visual Studio IDE 文档。

注意：GitHub Copilot 当前不适用于 Visual Studio for Mac。

在 Visual Studio 中安装 GitHub Copilot 扩展

若要使用 GitHub Copilot，必须先安装 GitHub Copilot 扩展。

  1. 在 Visual Studio 菜单栏中，单击“扩展”，然后单击“管理扩展” 。

    Visual Studio 中菜单栏的屏幕截图。 “扩展”菜单已打开，“管理扩展”选项以橙色轮廓突出显示。

  2. 在“管理扩展”窗口中，单击“Visual Studio Marketplace”，搜索 GitHub Copilot 扩展，然后单击“下载”。

    搜索结果列表的屏幕截图。 在 GitHub Copilot 扩展旁边，“下载”按钮以橙色轮廓突出显示。

  3. 关闭“管理扩展”窗口，然后退出并重新启动 Visual Studio。

  4. （可选）若要检查是否已安装并启用 GitHub Copilot，请返回到“管理扩展”，单击“已安装的扩展”以查看当前安装的扩展，然后单击“GitHub Copilot”以查看状态信息。

    Visual Studio 中已安装扩展的列表的屏幕截图。 “GitHub Copilot”扩展以橙色轮廓突出显示。

  5. 在 Visual Studio 中打开或创建新项目。

  6. 要启用 GitHub Copilot，请确保已将 GitHub 帐户添加到 Visual Studio。 有关详细信息，请参阅 Microsoft 文档中的在 Visual Studio 中使用 GitHub 帐户。

查看第一个建议

注意：如果为 GitHub Copilot 启用了重复检测，则使用提供的代码示例时，可能会收到有限的建议或没有建议。 作为替代方法，你可以首先键入自己的代码，以查看来自 GitHub Copilot 的建议。 有关重复检测的详细信息，请参阅“在 GitHub.com 上配置 GitHub Copilot 设置”。

GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询。 以下示例使用的是 C#，但其他语言的工作方式类似。

  1. 在 Visual Studio 中，创建新的 C# (*.cs) 文件。

  2. 在 C# 文件中，键入以下函数签名。 GitHub Copilot 将自动以灰色文本建议整个函数正文，如下所示。 具体的建议可能会有所不同。

    C#
    int CalculateDaysBetweenDates(

  3. 要接受建议，请按 Tab。

查看替代建议

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

  1. 在 Visual Studio 中，创建新的 C# (*.cs) 文件。

  2. 在 C# 文件中，键入以下函数签名。 GitHub Copilot 将向你显示建议。

    C#
    int CalculateDaysBetweenDates(

  3. 如果替代建议可用，可以通过按 Alt+ 查看这些替代。 （或按 Alt+,）来查看这些替代项。

  4. 或者，可以将鼠标悬停在建议上方，查看 GitHub Copilot 命令面板以选择建议。

  5. 若要接受建议，请按 Tab。若要拒绝所有建议，请按 Esc。

从注释生成代码建议

可以在注释中使用自然语言描述要执行的操作，GitHub Copilot 会提供代码建议来实现你的目标。

  1. 在 Visual Studio 中，创建新的 C# (*.cs) 文件。

  2. 在 C# 文件中，键入以下注释。 GitHub Copilot 将建议函数的实现。

    C#
    using System.Xml.Linq;

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

// find all images

  3. 要接受建议，请按 Tab。

启用或禁用 GitHub Copilot

Visual Studio 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 启用还是禁用。 启用后，图标的背景色将与状态栏颜色相匹配。 禁用后，将有一条对角线穿过它。

  1. 若要启用或禁用 GitHub Copilot，请单击 Visual Studio 窗口底部面板中的 GitHub Copilot 图标。

    Visual Studio 中编辑器边距的屏幕截图，其中突出显示 GitHub Copilot 图标。

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

    • 若要全局禁用 GitHub Copilot 的建议，请单击“全局启用”。
    • 若要禁用指定语言的 GitHub Copilot 的建议，请单击“对 LANGUAGE 启用”。

关于 GitHub Copilot 和 Visual Studio Code

GitHub Copilot 在编写代码时提供 AI 对程序员的自动完成样式的建议。 有关详细信息，请参阅“关于 GitHub Copilot Individual”。

如果使用 Visual Studio Code，可以直接在编辑器中查看并合并来自 GitHub Copilot 的建议。 本指南演示如何在适用于 macOS、Windows 或 Linux 的 Visual Studio Code 中使用 GitHub Copilot。

先决条件

在 Visual Studio Code 中安装 GitHub Copilot 扩展

若要使用 GitHub Copilot，必须先安装 GitHub Copilot 扩展。

  1. 在 Visual Studio Code Marketplace 中，转到 GitHub Copilot 扩展页，然后单击“安装”。

  2. 此时会显示一个弹出窗口，要求打开 Visual Studio Code。 单击“打开 Visual Studio Code”。

  3. 在 Visual Studio Code 的“扩展: GitHub Copilot”选项卡中，单击“安装”。

  4. 如果以前未在 GitHub 帐户中授权 Visual Studio Code，系统会提示你在 Visual Studio Code 中登录到 GitHub。

    • 如果以前已在 GitHub 上的帐户中授权 Visual Studio Code，系统将会自动授权 GitHub Copilot。

    • 如果未收到授权提示，请单击 Visual Studio Code 窗口底部面板中的钟形图标。

      带有 GitHub Copilot 图标的 Visual Studio Code 任务栏的屏幕截图。 钟形图标用深橙色框标出。

  5. 在浏览器中，GitHub 将请求 GitHub Copilot 所需的权限。 若要批准这些权限，请单击“授权 Visual Studio Code”。

  6. 要确认身份验证，请在 Visual Studio Code 的“Visual Studio Code”对话框中单击“打开”。

查看第一个建议

注意：如果为 GitHub Copilot 启用了重复检测，则使用提供的代码示例时，可能会收到有限的建议或没有建议。 作为替代方法，你可以首先键入自己的代码，以查看来自 GitHub Copilot 的建议。 有关重复检测的详细信息，请参阅“在 GitHub.com 上配置 GitHub Copilot 设置”。

GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询。 以下示例使用的是 JavaScript，但其他语言的工作方式类似。

  1. 在 Visual Studio Code 中，创建一个新的 JavaScript (*.js) 文件。

  2. 在 JavaScript 文件中，键入以下函数标头。 GitHub Copilot 将自动以灰色文本建议整个函数正文，如下所示。 具体的建议可能会有所不同。

    JavaScript
    function calculateDaysBetweenDates(begin, end) {

  3. 要接受建议，请按 Tab。

注意：**** 如果未看到建议，请确保已启用 GitHub Copilot。 应在 Visual Studio Code 窗口右下角看到 Copilot 图标。

如果文件已配置为 GitHub Copilot 的排除内容，则状态栏中的图标将有一条对角线穿过。 将鼠标悬停在该图标上可看到工具提示，告知哪些设置已应用此限制。

VS Code 中 Copilot 图标的屏幕截图，其中包含内容排除的工具提示。

有关详细信息，请参阅“为 GitHub Copilot 配置内容排除”。

查看替代建议