跳至主要内容

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

在编辑器中使用 GitHub Copilot 获取代码建议。

简介

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

本指南中的示例使用 Java,但其他语言也会有类似效果。

欲了解更多信息,请参阅 在 IDE 中的 GitHub Copilot 代码建议

先决条件

  • 访问 Copilot。在 JetBrains 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 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 IDEs 工具查找器进行下载。

  • 最新版本的 GitHub Copilot 扩展。请参阅 JetBrains Marketplace 中的 GitHub Copilot 插件。有关安装说明,请参阅 在您的环境中安装 GitHub Copilot 扩展

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

获取代码建议

GitHub Copilot 会在你输入时提供代码建议。例如,在 Java 文件中,输入 class Test 来创建一个类。

GitHub Copilot 会自动以灰色文字建议类体。要接受该建议,请按 Tab

你也可以在注释中使用自然语言描述想要完成的功能,Copilot 会建议相应的代码。例如,在 Java 文件中输入以下注释。

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

GitHub Copilot 会自动建议代码。要接受该建议,请按 Tab

GitHub Copilot 会尝试匹配你的代码的上下文和风格。你始终可以编辑所建议的代码。

提示

如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理

显示替代建议

针对同一输入,GitHub Copilot 可能会提供多个建议。你可以选择使用其中的某个建议,或全部拒绝。

例如,在 Java 文件中输入以下行,然后按 Enter

Java
private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 会向你展示一个建议。

将鼠标悬停在该建议上,会出现用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议,请点击控件中的前向或后向箭头按钮。

你也可以使用键盘快捷键显示替代建议。

操作系统查看下一个建议查看上一个建议
macOSOption+]Option+[
Windows 或 LinuxAlt+]Alt+[

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

在新标签页中显示多个建议

如果你不想使用 GitHub Copilot 提供的任何初始建议,可以在新标签页中显示多个建议。

例如,在 Java 文件中输入以下行。

Java
private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 会向你展示一个建议。

要打开一个包含多个额外建议的新标签页,请使用以下键盘快捷键,然后单击 Open GitHub Copilot

操作系统打开多个建议
macOSCommand+Shift+A
Windows 或 LinuxCtrl+Enter

要接受某个建议,请在该建议下方单击 Accept suggestion NUMBER。要拒绝所有建议,关闭该标签页。

接受部分建议

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

例如,在 Java 文件中输入以下行。

Java
private int calculateDaysBetweenDates(Date date1,

GitHub Copilot 会以灰色文字显示一个建议。实际建议可能有所不同。

将鼠标悬停在该建议上,会出现用于选择建议的 Copilot 控件。要仅接受建议的下一个词,请在控件中单击 Accept Word

或者,你可以使用键盘快捷键接受建议的下一个词。

操作系统接受下一个单词接受下一行
macOSCommand+Command+Control+
Windows 或 LinuxControl+Control+Alt+

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

简介

本指南演示如何在 Windows 版 Visual Studio 中获取 GitHub Copilot 的代码建议。要查看其他流行编码环境的说明,请使用页面顶部的工具切换器。

本指南中的示例使用 C#,但其他语言也会有类似效果。

欲了解更多信息,请参阅 在 IDE 中的 GitHub Copilot 代码建议

先决条件

  • 访问 Copilot。在 Visual Studio 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 Copilot 计划以获取完整访问权限。请参阅 什么是 GitHub Copilot?

  • 兼容的 Visual Studio 版本。要在 Visual Studio 中使用 GitHub Copilot,您必须安装 Windows 版 Visual Studio 2022 17.8 或更高版本。更多信息,请参阅 Microsoft 文档中的 安装 Visual Studio

  • Visual Studio 的 GitHub Copilot 扩展。关于如何安装 Copilot 扩展的说明,请参阅 Microsoft 文档中的 在 Visual Studio 中安装 GitHub Copilot

  • 将您的 GitHub 账户添加到 Visual Studio。请参阅 Microsoft 文档中的 将 GitHub 账户添加到 Visual Studio 密钥链

获取代码建议

GitHub Copilot 会在你输入时提供代码建议。例如,在 C# 文件中键入以下函数签名。

C#
int CalculateDaysBetweenDates(

GitHub Copilot 会自动以灰色文字建议完整的函数体。要接受该建议,请按 Tab

你也可以在注释中使用自然语言描述想要完成的功能,Copilot 会建议相应的代码。例如,在 C# 文件中键入以下注释。

C#
using System.Xml.Linq;

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

// find all images

GitHub Copilot 会建议函数的实现。要接受该建议,请按 Tab

提示

如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理

显示替代建议

针对同一输入,GitHub Copilot 可能会提供多个建议。你可以选择使用其中的某个建议,或全部拒绝。

例如,在 C# 文件中键入以下函数签名。

C#
int CalculateDaysBetweenDates(

GitHub Copilot 会向你展示一个建议。

将鼠标悬停在该建议上,会出现用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议,请点击控件中的前向或后向箭头按钮。

或者,你可以按 Alt+.(或 Alt+,)显示替代建议。

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

获取注释建议

注意

注释建议在 Visual Studio 17.14 Preview 2 及更高版本中可用。

GitHub Copilot 可以通过分析你编写的代码并生成描述代码功能的注释来为你的代码提供注释建议。对于 Copilot Free 用户,注释建议计入每月的 Copilot Chat 使用量,而不计入代码建议使用量。

以下语言提供注释建议:

  • C#
  • C++

启用注释建议

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

针对 C++

  1. 在 Visual Studio 中的 Tools(工具)菜单,单击 Options(选项)。
  2. 在左侧面板,单击 Text Editor(文本编辑器)。
  3. 单击 C++,然后单击 Code Style(代码样式)。
  4. Code Style(代码样式)标题下,单击 General(常规)。
  5. 在 “Comments” 下,从下拉框中选择 Xml Doc Comments
  6. 选择 Insert existing comment style at the start of new lines when writing comments(在编写注释时,在新行开头插入现有注释样式)和 Continue single line comments.(继续单行注释),然后单击 OK
  7. Options(选项)选项卡的左侧面板,单击 GitHub
  8. 单击 Copilot,然后单击 Editor(编辑器)。
  9. 选择 Enable AI generated descriptions for auto-inserted documentation comments in supported languages(在受支持的语言中为自动插入的文档注释启用 AI 生成的描述)。

针对 C#

  1. 在 Visual Studio 中的 Tools(工具)菜单,单击 Options(选项)。
  2. 在左侧面板,单击 Languages(语言)。
  3. 单击 C#,然后单击 More Settings(更多设置),再单击 Advanced(高级)。
  4. 在 “Comments” 下,选择 Generate XML documentation comments for ///Insert // at the start of new lines when writing // comments、以及 Insert * at the start of new lines when writing /* */ comments.,然后单击 OK
  5. Options(选项)选项卡的左侧面板,单击 GitHub
  6. 单击 Copilot,然后单击 Editor(编辑器)。
  7. 选择 Enable AI generated descriptions for auto-inserted documentation comments in supported languages(在受支持的语言中为自动插入的文档注释启用 AI 生成的描述)。

使用注释建议

要启动注释建议,请在代码之前键入该语言的标准注释起始符(例如 ///),然后等待建议出现。

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

根据你正在进行的编辑,Copilot 会预测你可能进行的下一次编辑位置并提供补全建议。

你可以使用 Tab 在建议的代码更改之间导航,这样无需手动搜索文件或引用即可更快找到相关编辑。再次按 Tab 可接受建议。

编辑器左侧的垂直标尺中出现的箭头表示有可用的编辑建议。单击该箭头可打开编辑建议菜单,其中提供键盘快捷键。如果编辑建议位于当前编辑视图之外,箭头会向上或向下指示下一个建议所在位置。

简介

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

本指南中的示例使用 JavaScript,但其他语言也会有类似效果。

欲了解更多信息,请参阅 在 IDE 中的 GitHub Copilot 代码建议

先决条件

获取代码建议

GitHub Copilot 会在你输入时提供代码建议。例如,在 JavaScript 文件中键入以下函数头部。

JavaScript
function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 会自动以灰色文字建议函数的其余部分。要接受该建议,请按 Tab

你也可以在注释中使用自然语言描述想要完成的功能,Copilot 会建议相应的代码。例如,在 JavaScript 文件中键入以下注释。

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

GitHub Copilot 会自动建议代码。要接受该建议,请按 Tab

提示

如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理

显示替代建议

针对同一输入,GitHub Copilot 可能会提供多个建议。你可以选择使用其中的某个建议,或全部拒绝。

例如,在 JavaScript 文件中键入以下函数头部,然后按 Enter

JavaScript
function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 会向你展示一个建议。

将鼠标悬停在该建议上,会出现用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议,请点击控件中的前向或后向箭头按钮。

你也可以使用键盘快捷键显示替代建议。

操作系统查看下一个建议查看上一个建议
macOSOption (⌥) or Alt+]Option (⌥) or Alt+[
Windows 或 LinuxAlt+]Alt+[

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

在新标签页中显示多个建议

如果你不想使用 GitHub Copilot 提供的任何初始建议,可以在新标签页中显示多个建议。

例如,在 JavaScript 文件中键入以下函数头部,然后按 Enter

JavaScript
function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 会向你展示一个建议。现在按 Ctrl+Enter 打开一个包含多个额外选项的新标签页。

要接受某个建议,请在该建议下方单击 Accept suggestion NUMBER。要拒绝所有建议,关闭该标签页。

接受部分建议

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

例如,在 JavaScript 文件中键入以下函数头部,然后按 Enter

JavaScript
function calculateDaysBetweenDates(begin, end) {

GitHub Copilot 将自动以灰色文字建议完整的函数体。具体建议可能有所不同。

将鼠标悬停在该建议上,会出现用于选择建议的 Copilot 控件。要仅接受建议的下一个词,请在控件中单击 Accept Word

或者,你可以使用键盘快捷键接受建议的下一个词。

操作系统接受下一个单词
macOSCommand+
Windows 或 LinuxControl+

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

“下一个编辑建议”会根据持续更改预测可能需要的编辑位置和内容。

你可以使用 Tab 在建议的代码更改之间导航,这样无需手动搜索文件或引用即可更快找到相关编辑。再次按 Tab 可接受建议。

编辑器左侧标尺中的箭头表示有可用的编辑建议。将鼠标悬停在箭头上可访问编辑建议菜单,其中提供键盘快捷键和设置选项。如果编辑建议位于当前编辑视图之外,箭头会向上或向下指示下一个建议所在位置。

Screenshot of the gutter menu in Visual Studio Code. The arrow is outlined in dark orange.

欲获取更多细节和示例,请参阅 VS Code 文档中的 VS Code 中的 GitHub Copilot 内联建议

更改 AI 模型

你可以更改用于生成内联建议的大语言模型。更多信息请参阅 更改 GitHub Copilot 内联建议的 AI 模型

简介

本指南演示如何在 Vim/Neovim 中获取 GitHub Copilot 的代码建议。要查看其他流行编码环境的说明,请使用页面顶部的工具切换器。

先决条件

  • 访问 Copilot。在 Vim/Neovim 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 Copilot 计划以获取完整访问权限。请参阅 什么是 GitHub Copilot?

  • 兼容的 Vim/Neovim 版本。在 Vim/Neovim 中使用 GitHub Copilot,需要安装 Vim 9.0.0185(或更高)/ Neovim 0.6(或更高)以及 Node.js 18(或更高)版本。更多信息请参阅 Vim / Neovim 文档Node.js 网站

  • Vim/Neovim 的 GitHub Copilot 扩展。要在 Vim/Neovim 中使用 GitHub Copilot,必须安装 GitHub Copilot 插件。更多信息请参阅 在你的环境中安装 GitHub Copilot 扩展

学习在 Vim/Neovim 中使用 GitHub Copilot

GitHub Copilot 在 Vim/Neovim 中会在你输入时提供内联建议。要接受建议,请按 tab 键。

欲获取更多使用 GitHub Copilot 在 Vim/Neovim 中的帮助,请运行以下命令查看插件文档。

Shell
:help copilot

简介

本指南演示如何在 Azure Data Studio 中获取 GitHub Copilot 的代码建议。要查看其他流行编码环境的说明,请使用页面顶部的工具切换器。

先决条件

  • 访问 Copilot。在 Azure Data Studio 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 Copilot 计划以获取完整访问权限。请参阅 什么是 GitHub Copilot?

  • 兼容的 Azure Data Studio 版本。使用 GitHub Copilot 需要安装 Azure Data Studio 1.44.0 或更高版本。更多信息请参阅 Azure Data Studio 文档中的 Azure Data Studio 下载页面

  • Azure Data Studio 的 GitHub Copilot 扩展。在 Azure Data Studio 中使用 GitHub Copilot,需要安装 GitHub Copilot 扩展。更多信息请参阅 在你的环境中安装 GitHub Copilot 扩展

获取代码建议

GitHub Copilot 可以在你创建 Azure Data Studio 中的 SQL 数据库时提供内联建议。例如,当你编写连接两个表的查询时,Copilot 可能会根据打开的编辑器、工作区中的其他文件以及常见语法模式建议连接条件。

在 SQL 文件中输入以下查询:

SQL
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN

GitHub Copilot 会自动以灰色文字建议一个连接条件。实际建议可能有所不同。要接受该建议,请按 Tab

你也可以在注释中使用自然语言描述想要完成的功能,Copilot 会建议实现代码。例如,在 SQL 文件中键入以下注释。

SQL
SELECT TokenColor, COUNT(UserID) AS UserCount
FROM Tag.Users
GROUP BY TokenColor
-- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red
-- and rename the columns to match the colors
SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]

GitHub Copilot 会自动建议代码。要接受该建议,请按 Tab

提示

如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理

显示替代建议

对于某些建议,GitHub Copilot 可能会提供多个备选。你可以选择使用其中的某个建议,或全部拒绝。

例如,在 SQL 文件中键入以下查询。

SQL
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN

GitHub Copilot 会向你展示一个建议。

将鼠标悬停在该建议上,会出现用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议,请点击控件中的前向或后向箭头按钮。

你也可以使用键盘快捷键显示替代建议。

操作系统查看下一个建议查看上一个建议
macOSOption+[Option+]
Windows 或 LinuxAlt+[Alt+]

要接受建议,请单击 Copilot 控件中的 “Accept”,或按 Tab。要拒绝所有建议,请按 Esc

接受部分建议

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

例如,在 SQL 文件中键入以下查询。

SQL
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN

GitHub Copilot 会以灰色文字向你展示一个建议。实际建议可能有所不同。

将鼠标悬停在该建议上,会出现用于选择建议的 Copilot 控件。要仅接受建议的下一个词,请在控件中单击 Accept Word

或者,你可以使用键盘快捷键接受建议的下一个词。

操作系统接受下一个单词
macOSCommand+
Windows 或 LinuxControl+

如果你想接受建议的下一行,需要为命令 editor.action.inlineSuggest.acceptNextLine 设置自定义键盘快捷键。有关设置自定义快捷键的更多信息,请参阅 Microsoft 文档中的 Azure Data Studio 键盘快捷键

简介

本指南演示如何在 Xcode 中获取 GitHub Copilot 的代码建议。要查看其他流行编码环境的说明,请使用页面顶部的工具切换器。

先决条件

  • 访问 Copilot。在 Xcode 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 Copilot 计划以获取完整访问权限。请参阅 什么是 GitHub Copilot?

  • Xcode 的 GitHub Copilot 扩展。要在 Xcode 中使用 GitHub Copilot,需要安装 GitHub Copilot for Xcode 扩展。请参阅 在你的环境中安装 GitHub Copilot 扩展

获取代码建议

GitHub Copilot 在你输入时提供代码建议。例如,在 Swift 文件中键入以下函数签名。

Swift
func calculateDaysBetweenDates(

GitHub Copilot 会自动以灰色文字建议完整的函数体。要接受建议的第一行,请按 Tab。要查看完整建议,请按住 Option;要接受完整建议,请按 Option+Tab

改进代码建议

如果你遇到代码建议的问题,例如冲突或缺失的建议,可以尝试以下操作:

  • 禁用 Xcode 本机的预测性文本补全:为了避免收到两套代码建议,可禁用 Xcode 本机的预测性文本补全。该设置位于 Xcode 设置的 “Editing” 选项卡下的 “Text Editing”。
  • 检查 Copilot 中的重复检测:如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理
  • 检查更新并重新启动 Xcode:确保你已在扩展应用中安装了最新版本的 Copilot for Xcode,并重新启动 Xcode。

你也可以在 Copilot for Xcode 代码库中提交 Issue。

“下一个编辑建议”会根据持续更改预测可能需要的编辑位置和内容。

你可以使用 Tab 在建议的代码更改之间导航,这样无需手动搜索文件或引用即可更快找到相关编辑(除非你已为 GitHub Copilot for Xcode 扩展禁用了 “Accept suggestions with Tab” 设置)。

编辑器左侧标尺中的箭头表示有可用的编辑建议。将鼠标悬停在箭头上可访问编辑建议菜单,其中提供键盘快捷键和设置选项。

Screenshot of the gutter menu in Xcode. The arrow is outlined in dark orange.

简介

本指南演示如何在 Eclipse 中获取 GitHub Copilot 的代码建议。要查看其他流行编码环境的说明,请使用页面顶部的工具切换器。

先决条件

  • 访问 Copilot。在 Eclipse 中使用 GitHub Copilot,需要通过 Copilot Free 获得有限访问,或购买付费 Copilot 计划以获取完整访问权限。请参阅 什么是 GitHub Copilot?

  • Eclipse 的 GitHub Copilot 扩展。要在 Eclipse 中使用 GitHub Copilot,必须安装 GitHub Copilot 扩展。请参阅 在你的环境中安装 GitHub Copilot 扩展

获取代码建议

GitHub Copilot 在你输入时提供代码建议。例如,在 Java 文件中键入以下函数头部。

Java
public int getDiff(int a, int b)

GitHub Copilot 会自动建议函数的其余部分。要接受该建议,请按 Tab。要丢弃该建议,请按 Esc

你也可以在注释中使用自然语言描述想要完成的功能,Copilot 会建议相应的代码。例如,在 Java 文件中输入以下注释。

Java
/*
 * Return the difference between two different integers.
 */

GitHub Copilot 会自动建议代码。

提示

如果 Copilot 提供的建议有限或没有建议,可能是因为启用了重复检测。有关重复检测的更多信息,请参阅 个人订阅者的 GitHub Copilot 策略管理

手动触发内联建议

你也可以使用键盘快捷键触发内联建议。

操作系统触发内联建议
macOSOption+Command+/
Windows 或 LinuxCtrl+Alt+/

接受部分建议

如果你不想接受 Copilot 的完整建议,可以只接受建议的下一个单词。

操作系统接受下一个单词
macOSCommand+
Windows 或 LinuxCtrl+

“下一个编辑建议”会根据持续更改预测可能需要的编辑位置和内容。

你可以使用 Tab 在建议的代码更改之间导航,这样无需手动搜索文件或引用即可更快找到相关编辑。再次按 Tab 可接受建议。

编辑器左侧标尺中的箭头表示有可用的编辑建议。将鼠标悬停在箭头上可访问编辑建议菜单,其中提供键盘快捷键和设置选项。

Screenshot of the gutter menu in Eclipse. The arrow is outlined in dark orange.

后续步骤

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.