跳到主要内容

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

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

开始免费试用

关于GitHub Copilot和JetBrains IDEs

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

本指南中的示例使用Java,但其他语言的工作原理类似。GitHub Copilot为许多语言和各种框架提供了建议,但对于Python、JavaScript、TypeScript、Ruby、Go、C#和C++尤其适用。GitHub Copilot还可以帮助为数据库生成查询,或为API和框架生成建议。

先决条件

  • 订阅Copilot。若要在JetBrains中使用GitHub Copilot,您必须具有活动的GitHub Copilit订阅。有关如何访问Copilot的信息,请参阅“关于GitHub Copilot."

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

    • IntelliJ IDEA(终极、社区、教育)
    • 安卓工作室
    • 应用程序代码
    • CLion公司
    • 与我一起编码来宾
    • 数据夹点
    • 数据表
    • 戈兰
    • JetBrains客户端
    • 主生产计划
    • PhpStorm公司
    • PyCharm(专业、社区、教育)
    • 骑手
    • RubyMine公司
    • RustRover公司
    • WebStorm网站

    请参阅JetBrains IDEs公司要下载的工具查找器。

  • GitHub Copilot插件。请参阅GitHub Copilot插件在JetBrains市场。有关安装说明,请参阅“在您的环境中安装GitHub Copilot扩展."

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

获取代码建议

GitHub Copilot在您键入时提供编码建议。例如,在Java文件中,通过键入以下内容创建类类别测试.

GitHub Copilot将以灰色文本自动建议类主体。要接受建议,请按选项卡.

你也可以在注释中用自然语言描述你想做的事情,Copilot会建议代码来实现你的目标。例如,在Java文件中键入以下注释:

Java语言
//查找没有替换文本的所有图像
//给他们一个红色的边框
空隙 过程 (){

GitHub Copilot将自动建议代码。要接受建议,请按选项卡.

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

提示

如果您从Copilot收到的建议有限或没有,则可能启用了重复检测。有关重复检测的更多信息,请参阅“作为个人订户管理Copilot策略."

显示备选建议

对于任何给定的输入,GitHub Copilot都可以提供多种建议。您可以选择要使用的建议,也可以拒绝所有建议。

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

Java语言
私有的 整数 计算日期之间的天数(日期日期1,

GitHub Copilot将为您提供建议。

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

您还可以使用键盘快捷键显示其他建议:

操作系统请参阅下一个建议参见前面的建议
macOS操作系统选项+]选项+[
Windows或Linux中高音+]中高音+[

要接受建议,请单击Copilot命令调色板中的“accept”,或按选项卡。要拒绝所有建议,请按Esc公司.

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

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

例如,在Java文件中键入以下行:

Java语言
私有的 整数 计算日期之间的天数(日期日期1,

GitHub Copilot将为您提供建议。

要打开包含多个其他建议的新选项卡,请使用以下键盘快捷方式,然后单击打开GitHub Copilot:

操作系统打开多个建议
macOS操作系统命令+班次+A类
Windows或LinuxCtrl键+输入

要接受建议,请在建议下方单击接受建议编号。要拒绝所有建议,请关闭选项卡。

接受部分建议

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

例如,在Java文件中键入以下行:

Java语言
私有的 整数 计算日期之间的天数(日期日期1,

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

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

或者,您可以使用键盘快捷方式接受建议的下一个单词:

操作系统接受下一个单词接受下一行
macOS操作系统命令+命令+控制+
Windows或Linux控制+控制+中高音+

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

关于GitHub Copilot和Visual Studio

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

本指南中的示例使用C#,但其他语言的工作原理类似。GitHub Copilot为许多语言和各种框架提供了建议,但对于Python、JavaScript、TypeScript、Ruby、Go、C#和C++尤其适用。GitHub Copilot还可以帮助为数据库生成查询,或为API和框架生成建议。

先决条件

  • 订阅Copilot。若要在Visual Studio中使用GitHub Copilot,您必须具有活动的GitHub Copilot订阅。有关如何访问Copilot的信息,请参阅“关于GitHub Copilot."

  • Visual Studio的兼容版本。若要在Visual Studio中使用GitHub Copilot,必须安装Visual Studio for Windows 2022 17.8或更高版本。有关详细信息,请参阅“安装Visual Studio”。

  • Visual Studio的GitHub Copilot扩展。有关如何安装Copilot扩展的说明,请参阅“在Visual Studio中安装GitHub Copilot”。

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

获取代码建议

GitHub Copilot在您键入时提供编码建议。例如,键入此函数C#文件中的签名:

C类#
整数 计算日期之间的天数(

GitHub Copilot将以灰色文本自动建议整个函数体。要接受建议,请按选项卡.

你也可以在注释中用自然语言描述你想做的事情,Copilot会建议代码来实现你的目标。例如,在C#文件中键入以下注释:

C类#
使用系统。Xml文件。林克;无功功率,无功功率doc=X文档。加载(“索引.xhml”);//查找所有图像

GitHub Copilot将建议实现该功能。要接受建议,请按选项卡.

提示

如果您从Copilot收到的建议有限或没有,则可能启用了重复检测。有关重复检测的更多信息,请参阅“作为个人订户管理Copilot策略."

显示备选建议

对于任何给定的输入,GitHub Copilot都可以提供多种建议。您可以选择要使用的建议,也可以拒绝所有建议。

例如,在C#文件中键入此函数签名:

C类#
整数 计算日期之间的天数(

GitHub Copilot将为您提供建议。

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

或者,您可以通过按显示其他建议中高音+.(或中高音+,)在你的键盘上。

要接受建议,请单击Copilot命令调色板中的“accept”,或按选项卡。要拒绝所有建议,请按Esc公司.

关于GitHub Copilot和Visual Studio代码

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

本指南中的示例使用JavaScript,但其他语言的工作原理类似。GitHub Copilot为许多语言和各种框架提供了建议,但对于Python、JavaScript、TypeScript、Ruby、Go、C#和C++尤其适用。GitHub Copilot还可以帮助为数据库生成查询,或为API和框架生成建议。

先决条件

  • 订阅Copilot。若要在Visual Studio代码中使用GitHub Copilot,您必须具有活动的GitHup Copilit订阅。有关如何访问Copilot的信息,请参阅“关于GitHub Copilot."

  • Visual Studio代码。若要在Visual Studio代码中使用GitHub Copilot,必须安装Visual Studio代码。有关更多信息,请参阅Visual Studio代码下载页.

  • Visual Studio代码的Copilot扩展。若要在Visual Studio代码中使用GitHub Copilot,必须安装GitHub Copilot扩展。有关详细信息,请参阅“在Visual Studio代码中设置GitHub Copilot”。

获取代码建议

GitHub Copilot在您键入时提供编码建议。例如,在JavaScript文件中键入此函数头:

JavaScript脚本
功能 计算日期之间的天数(开始,结束) {

GitHub Copilot将自动建议其余功能。要接受建议,请按选项卡.

你也可以在注释中用自然语言描述你想做的事情,Copilot会建议代码来实现你的目标。例如,在JavaScript文件中键入以下注释:

JavaScript脚本
//将函数写入
//查找没有替换文本的所有图像
//给他们一个红色的边框

GitHub Copilot将自动建议代码。要接受建议,请按选项卡.

提示

如果您从Copilot收到的建议有限或没有,则可能启用了重复检测。有关重复检测的更多信息,请参阅“作为个人订户管理Copilot策略."

显示备选建议

对于任何给定的输入,GitHub Copilot都可以提供多种建议。您可以选择要使用的建议,也可以拒绝所有建议。

例如,在JavaScript文件中键入此函数头,然后按输入:

JavaScript脚本
功能 计算日期之间的天数(开始,结束) {

GitHub Copilot将为您提供建议。

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

您还可以使用键盘快捷键显示其他建议:

操作系统请参阅下一个建议参见之前的建议
macOS操作系统选项(⌥)或Alt+]选项(⌥)或Alt+[
Windows或Linux中高音+]中高音+[

要接受建议,请单击Copilot命令调色板中的“accept”,或按选项卡。要拒绝所有建议,请按Esc公司.

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

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

例如,在JavaScript文件中键入此函数头,然后按输入:

JavaScript脚本
功能 计算日期之间的天数(开始,结束) {

GitHub Copilot将向您展示一个建议。现在按Ctrl键+输入打开带有多个附加选项的新选项卡。

要接受建议,请在建议下方单击接受建议编号。要拒绝所有建议,请关闭选项卡。

接受部分建议

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

例如,在JavaScript文件中键入此函数头,然后按输入:

JavaScript脚本
功能 计算日期之间的天数(开始,结束) {

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

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

或者,您可以使用键盘快捷方式接受建议的下一个单词:

操作系统接受下一个单词
macOS操作系统命令+
Windows或Linux控制+

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

关于GitHub Copilot和Vim/Neovim

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

先决条件

  • 订阅Copilot。若要在Vim/Neovim中使用GitHub Copilot,您必须具有活动的GitHub Copilot订阅。有关如何访问Copilot的信息,请参阅“关于GitHub Copilot."

  • 兼容版本的Vim/Neovim。要在Vim/Neovim中使用GitHub Copilot,必须安装Vim版本9.0.0185/Neovim版本0.6或更高版本以及Node.js版本18或更高。有关更多信息,请参阅维姆/Neovim文件Node.js网站.

  • Vim/Neovim的GitHub Copilot扩展。要在Vim/Neovim中使用GitHub Copilot,您必须安装GitHub Copilit插件。有关详细信息,请参阅“在您的环境中安装GitHub Copilot扩展."

学习在Vim/Neovim中使用GitHub Copilot

GitHub Copilot在您键入Vim/Neovim时提供内联建议。要接受建议,请按选项卡键。

有关在Vim/Neovim中使用GitHub Copilot的更多信息和指导,请运行以下命令查看插件文档:

壳牌公司
:帮助副驾驶员

关于GitHub Copilot和Azure Data Studio

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

先决条件

  • 订阅Copilot。若要在Azure Data Studio中使用GitHub Copilot,您必须具有活动的GitHup Copilots订阅。有关如何访问Copilot的信息,请参阅“关于GitHub Copilot."

  • Azure Data Studio的兼容版本。若要在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 Copilots扩展。有关详细信息,请参阅“在您的环境中安装GitHub Copilot扩展."

获取代码建议

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

在SQL文件中,键入以下查询:

SQL语言
选择[UserId],[红色],[橙色],[黄色],[绿色],[蓝色],[紫色],[彩虹]发件人[标签]。[记分板]内部 加入

GitHub Copilot将以灰色文本自动建议连接条件。确切的建议可能会有所不同。要接受建议,请按选项卡.

你也可以在注释中用自然语言描述你想做的事情,Copilot会建议代码来实现你的目标。例如,在SQL文件中键入以下注释:

SQL语言
选择标记颜色,计数(用户ID)AS公司用户计数发件人标签。用户集团 标记颜色--在tokencolor上显示紫色、蓝色、绿色、黄色、橙色、红色的查询
--并重命名列以匹配颜色
选择[紫色],[蓝色],[绿色],[黄色],[橙色],[红色]

GitHub Copilot将自动建议代码。要接受建议,请按选项卡.

提示

如果您从Copilot收到的建议有限或没有,则可能启用了重复检测。有关重复检测的更多信息,请参阅“作为个人订户管理Copilot策略."

显示备选建议

对于一些建议,GitHub Copilot可能会提供多种选择。您可以选择要使用的建议,也可以拒绝所有建议。

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

SQL语言
选择[UserId],[红色],[橙色],[黄色],[绿色],[蓝色],[紫色],[彩虹]发件人[标签]。[记分板]内部 加入

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

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

您还可以使用键盘快捷键显示其他建议:

操作系统请参阅下一个建议参见之前的建议
macOS操作系统选项+[选项+]
Windows或Linux中高音+[中高音+]

要接受建议,请单击Copilot控件中的“接受”,或按选项卡。要拒绝所有建议,请按Esc公司.

接受部分建议

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

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

SQL语言
选择[UserId],[红色],[橙色],[黄色],[绿色],[蓝色],[紫色],[彩虹]发件人[标签]。[记分板]内部 加入

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

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

或者,您可以使用键盘快捷方式接受建议的下一个单词:

操作系统接受下一个单词
macOS操作系统命令+
Windows或Linux控制+

如果要接受建议的下一行,则需要为该命令设置自定义键盘快捷方式editor.action.inline建议.acceptNextLine。有关设置自定义键盘快捷键的详细信息,请参阅“Azure Data Studio中的键盘快捷方式”。

接下来的步骤