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

关于 GitHub Copilot 和 JetBrains IDE

本指南演示了如何在 JetBrains IDE 中获取来自 GitHub Copilot 的代码建议。要查看其他常用编码环境的说明，请使用页面顶部的工具切换器。

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

先决条件

• Copilot 订阅。要在 JetBrains 中使用 GitHub Copilot，您必须拥有有效的 GitHub Copilot 订阅。有关如何获取 Copilot 访问权限的信息，请参阅“什么是 GitHub Copilot？”。

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

  • IntelliJ IDEA（Ultimate、Community、Educational）
  • Android Studio
  • AppCode
  • CLion
  • Code With Me Guest
  • DataGrip
  • DataSpell
  • GoLand
  • JetBrains Client
  • MPS
  • PhpStorm
  • PyCharm（Professional、Community、Educational）
  • Rider
  • RubyMine
  • RustRover
  • WebStorm
  • Writerside

  请参阅 JetBrains IDE 工具查找器以进行下载。

• GitHub Copilot 插件。请参阅 JetBrains Marketplace 中的 GitHub Copilot 插件。有关安装说明，请参阅“在您的环境中安装 GitHub Copilot 扩展”。

• 在您的 JetBrains IDE 中登录 GitHub。有关身份验证说明，请参阅“在您的环境中安装 GitHub Copilot 扩展”。

获取代码建议

GitHub Copilot 在您键入时提供代码建议。例如，在 Java 文件中，通过键入 class Test 创建一个类。

GitHub Copilot 将自动以灰色文本建议类体。要接受建议，请按 Tab。

您也可以在注释中使用自然语言描述您想要执行的操作，Copilot 将建议完成目标的代码。例如，在 Java 文件中键入以下注释：

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

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

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

GitHub Copilot 将尝试匹配代码的上下文和样式。您可以随时编辑建议的代码。

显示备选建议

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

例如，在 Java 文件中键入以下行，然后按 Enter：

private int calculateDaysBetweenDates(Date date1,

private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 将向您显示一个建议。

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

您也可以使用键盘快捷键来显示备选建议：

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

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

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

例如，在 Java 文件中键入以下行：

private int calculateDaysBetweenDates(Date date1,

private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 将向您显示一个建议。

要打开一个包含多个其他建议的新选项卡，请使用以下键盘快捷键，然后单击**打开 GitHub Copilot**：

要接受建议，请在建议下方单击**接受建议 NUMBER**。要拒绝所有建议，请关闭选项卡。

接受部分建议

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

例如，在 Java 文件中键入以下行：

private int calculateDaysBetweenDates(Date date1,

private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 将以灰色文本显示建议。确切的建议可能会有所不同。

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

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

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