关于 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（旗舰版、社区版、教育版）
- Android Studio
- AppCode
- CLion
- Code With Me Guest
- DataGrip
- DataSpell
- GoLand
- JetBrains Client
- MPS
- PhpStorm
- PyCharm（专业版、社区版、教育版）
- Rider
- RubyMine
- RustRover
- WebStorm
请参阅 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 将尝试匹配您代码的上下文和样式。您始终可以编辑建议的代码。
提示
如果您从 Copilot 收到的建议有限或没有，则您可能启用了重复检测。有关重复检测的更多信息，请参阅“管理 Copilot 策略作为个人订阅者”。
显示备选建议
对于任何给定的输入，GitHub Copilot 可能提供多个建议。您可以选择使用哪个建议，或拒绝所有建议。
例如，在 Java 文件中键入以下行，然后按 Enter
private int calculateDaysBetweenDates(Date date1,
private int calculateDaysBetweenDates(Date date1,
GitHub Copilot 将向您显示一个建议。
现在将鼠标悬停在建议上以显示用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议，请单击控件中的前进或后退箭头按钮。
您还可以使用键盘快捷键显示备选建议
| 操作系统 | 查看下一个建议 | 查看上一个建议 |
|---|---|---|
| macOS | Option+] | Option+[ |
| Windows 或 Linux | Alt+] | Alt+[ |
要接受建议，请单击 Copilot 命令面板中的“接受”，或按 Tab。要拒绝所有建议，请按 Esc。
在新选项卡中显示多个建议
如果您不想使用 GitHub Copilot 提供的任何初始建议，您可以在新选项卡中显示多个建议。
例如，在 Java 文件中键入以下行
private int calculateDaysBetweenDates(Date date1,
private int calculateDaysBetweenDates(Date date1,
GitHub Copilot 将向您显示一个建议。
要使用以下键盘快捷键在新选项卡中打开包含多个其他建议，然后单击打开 GitHub Copilot
| 操作系统 | 打开多个建议 |
|---|---|
| macOS | Command+Shift+A |
| Windows 或 Linux | Ctrl+Enter |
要接受建议，请在建议下方单击接受建议 NUMBER。要拒绝所有建议，请关闭选项卡。
接受部分建议
如果您不想接受 GitHub Copilot 的整个建议，则可以接受建议的下一个单词或下一行。
例如，在 Java 文件中键入以下行
private int calculateDaysBetweenDates(Date date1,
private int calculateDaysBetweenDates(Date date1,
GitHub Copilot 将以灰色文本显示建议。确切的建议可能有所不同。
现在将鼠标悬停在建议上以显示 GitHub Copilot 控件，用于选择建议。要仅接受建议的下一个单词，请在控件中单击接受单词。
或者，您可以使用键盘快捷键接受建议的下一个单词
| 操作系统 | 接受下一个单词 | 接受下一行 |
|---|---|---|
| macOS | Command+→ | Command+Control+→ |
| Windows 或 Linux | Control+→ | Control+Alt+→ |
如果您想接受建议的下一行，则需要为命令 editor.action.inlineSuggest.acceptNextLine 设置自定义键盘快捷键。有关设置自定义键盘快捷键的更多信息，请参阅“在您的环境中配置 GitHub Copilot”。
关于 GitHub Copilot 和 Visual Studio
本指南演示如何从 Visual Studio for Windows 中的 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 或更高版本。有关更多信息，请参阅 Microsoft 文档中的“安装 Visual Studio”。
- Visual Studio 的 GitHub Copilot 扩展。有关如何安装 Copilot 扩展的说明，请参阅 Microsoft 文档中的“在 Visual Studio 中安装 GitHub Copilot”。
- 将你的 GitHub 帐户添加到 Visual Studio。请参阅 Microsoft 文档中的 将你的 GitHub 帐户添加到 Visual Studio 密钥链。
获取代码建议
在键入时，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。
提示
如果您从 Copilot 收到的建议有限或没有，则您可能启用了重复检测。有关重复检测的更多信息，请参阅“管理 Copilot 策略作为个人订阅者”。
显示备选建议
对于任何给定的输入，GitHub Copilot 可能提供多个建议。您可以选择使用哪个建议，或拒绝所有建议。
例如，在 C# 文件中键入此函数签名
int CalculateDaysBetweenDates(
int CalculateDaysBetweenDates(
GitHub Copilot 将向您显示一个建议。
现在将鼠标悬停在建议上以显示用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议，请单击控件中的前进或后退箭头按钮。
或者，你可以按键盘上的 Alt+.（或 Alt+,）显示备选建议。
要接受建议，请单击 Copilot 命令面板中的“接受”，或按 Tab。要拒绝所有建议，请按 Esc。
关于 GitHub Copilot 和 Visual Studio Code
本指南演示如何在 Visual Studio Code 中从 GitHub Copilot 获取编码建议。若要查看其他流行编码环境的说明，请使用页面顶部的工具切换器。
本指南中的示例使用 JavaScript，但其他语言的工作方式类似。GitHub Copilot 为多种语言和各种框架提供建议，但对 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++ 的效果尤其好。GitHub Copilot 还可以帮助生成数据库查询，或为 API 和框架生成建议。
先决条件
-
订阅 Copilot。要在 Visual Studio Code 中使用 GitHub Copilot，你必须拥有有效的 GitHub Copilot 订阅。有关如何获取 Copilot 访问权限的信息，请参阅“关于 GitHub Copilot”。
-
Visual Studio Code。要在 Visual Studio Code 中使用 GitHub Copilot，你必须安装 Visual Studio Code。有关详细信息，请参阅 Visual Studio Code 下载页面。
-
Visual Studio Code 的 Copilot 扩展。要在 Visual Studio Code 中使用 GitHub Copilot，你必须安装 GitHub Copilot 扩展。有关详细信息，请参阅 Visual Studio Code 文档中的“在 Visual Studio Code 中设置 GitHub Copilot”。
获取代码建议
在键入时，GitHub Copilot 会提供编码建议。例如，在 JavaScript 文件中键入此函数头
function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
GitHub Copilot 会自动建议函数的其余部分。若要接受建议，请按 Tab。
您还可以使用自然语言在注释中描述您想做的事情，Copilot 将建议代码来实现您的目标。例如，在 JavaScript 文件中输入此注释
// write a function to // find all images without alternate text // and give them a red border
// write a function to
// find all images without alternate text
// and give them a red border
GitHub Copilot 将自动建议代码。要接受建议，请按 Tab。
提示
如果您从 Copilot 收到的建议有限或没有，则您可能启用了重复检测。有关重复检测的更多信息，请参阅“管理 Copilot 策略作为个人订阅者”。
显示备选建议
对于任何给定的输入，GitHub Copilot 可能提供多个建议。您可以选择使用哪个建议，或拒绝所有建议。
例如，在 JavaScript 文件中输入此函数头，然后按 Enter
function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
GitHub Copilot 将向您显示一个建议。
现在将鼠标悬停在建议上以显示用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议，请单击控件中的前进或后退箭头按钮。
您还可以使用键盘快捷键显示备选建议
| 操作系统 | 查看下一个建议 | 查看上一个建议 |
|---|---|---|
| macOS | Option (⌥) 或 Alt+] | Option (⌥) 或 Alt+[ |
| Windows 或 Linux | Alt+] | Alt+[ |
要接受建议，请单击 Copilot 命令面板中的“接受”，或按 Tab。要拒绝所有建议，请按 Esc。
在新选项卡中显示多个建议
如果您不想使用 GitHub Copilot 提供的任何初始建议，您可以在新选项卡中显示多个建议。
例如，在 JavaScript 文件中输入此函数头，然后按 Enter
function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
GitHub Copilot 将向您展示一个建议。现在按 Ctrl+Enter 以打开一个新选项卡，其中包含多个其他选项。
要接受建议，请在建议下方单击接受建议 NUMBER。要拒绝所有建议，请关闭选项卡。
接受部分建议
如果您不想接受 GitHub Copilot 的整个建议，则可以接受建议的下一个单词或下一行。
例如，在 JavaScript 文件中输入此函数头，然后按 Enter
function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
GitHub Copilot 将自动建议一个用灰色文本显示的完整函数体。确切的建议可能有所不同。
现在将鼠标悬停在建议上以显示 GitHub Copilot 控件，用于选择建议。要仅接受建议的下一个单词，请在控件中单击接受单词。
或者，您可以使用键盘快捷键接受建议的下一个单词
| 操作系统 | 接受下一个单词 |
|---|---|
| macOS | Command+→ |
| Windows 或 Linux | Control+→ |
如果您想接受建议的下一行，则需要为命令 editor.action.inlineSuggest.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 或更高版本。有关更多信息，请参阅 Vim / Neovim 文档 和 Node.js 网站。
-
Vim/Neovim 的 GitHub Copilot 扩展。要在 Vim/Neovim 中使用 GitHub Copilot，您必须安装 GitHub Copilot 插件。有关更多信息，请参阅“在您的环境中安装 GitHub Copilot 扩展”。
学习在 Vim/Neovim 中使用 GitHub Copilot
当您在 Vim/Neovim 中键入时，GitHub Copilot 会提供内联建议。要接受建议，请按 tab 键。
有关在 Vim/Neovim 中使用 GitHub Copilot 的更多信息和指导，请运行以下命令以查看插件文档
:help copilot
:help copilot
关于 GitHub Copilot 和 Azure Data Studio
本指南演示如何在 Azure Data Studio 中从 GitHub Copilot 获取编码建议。要查看其他流行编码环境的说明，请使用页面顶部的工具切换器。
先决条件
-
订阅 Copilot。要在 Azure Data Studio 中使用 GitHub Copilot，您必须拥有一个有效的 GitHub Copilot 订阅。有关如何获取 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 Copilot 扩展。有关详细信息，请参阅“在您的环境中安装 GitHub Copilot 扩展”。
获取代码建议
在 Azure Data Studio 中创建 SQL 数据库时，GitHub Copilot 可以为您提供内联建议。例如，如果您正在编写联接两个表的查询，Copilot 可能会从打开的编辑器中的列、工作区中的其他文件和常见语法模式中建议联接条件。
在 SQL 文件中，键入以下查询
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN
GitHub Copilot 将自动以灰色文本建议联接条件。确切的建议可能有所不同。要接受建议，请按 Tab。
您还可以在注释中使用自然语言描述您想要做的事情，Copilot 将建议实现您目标的代码。例如，在 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]
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 收到的建议有限或没有建议，则您可能启用了重复检测。有关重复检测的详细信息，请参阅“作为个人订阅者管理 Copilot 策略”。
显示备选建议
对于某些建议，GitHub Copilot 可能提供多个备选方案。您可以选择要使用的建议，或拒绝所有建议。
例如，在 SQL 文件中键入此查询
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN
GitHub Copilot 将向您显示一个建议。
现在将鼠标悬停在建议上以显示用于选择建议的 GitHub Copilot 控件。要显示下一个或上一个建议，请单击控件中的前进或后退箭头按钮。
您还可以使用键盘快捷键显示备选建议
| 操作系统 | 查看下一个建议 | 查看上一个建议 |
|---|---|---|
| macOS | Option+[ | Option+] |
| Windows 或 Linux | Alt+[ | Alt+] |
要接受建议，请在 Copilot 控件中单击“接受”，或按 Tab。要拒绝所有建议，请按 Esc。
接受部分建议
如果您不想接受 GitHub Copilot 的整个建议，则可以接受建议的下一个单词或下一行。
例如，在 SQL 文件中键入此查询
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]
FROM [Tag].[Scoreboard]
INNER JOIN
GitHub Copilot 将以灰色文本显示建议。确切的建议可能有所不同。
现在将鼠标悬停在建议上以显示 GitHub Copilot 控件，用于选择建议。要仅接受建议的下一个单词，请在控件中单击接受单词。
或者，您可以使用键盘快捷键接受建议的下一个单词
| 操作系统 | 接受下一个单词 |
|---|---|
| macOS | Command+→ |
| Windows 或 Linux | Control+→ |
如果您想接受建议的下一行，则需要为命令 editor.action.inlineSuggest.acceptNextLine 设置自定义键盘快捷键。有关设置自定义键盘快捷键的详细信息，请参阅 Microsoft 文档中的“Azure Data Studio 中的键盘快捷键”。
后续步骤
- 在编辑器中配置 Copilot - 您可以从编辑器中启用或禁用 GitHub Copilot，并为 Copilot 创建您自己首选的键盘快捷键。请参阅“在您的环境中配置 GitHub Copilot”。
- 开始使用 GitHub Copilot 聊天 - 了解如何使用 GitHub Copilot 聊天向 Copilot 询问信息和帮助。请参阅“在您的 IDE 中使用 GitHub Copilot 聊天”。
- 像专业人士一样使用 Copilot - 了解如何为 GitHub Copilot 编写有效的提示。请参阅 GitHub 博客中的“如何使用 GitHub Copilot：提示、技巧和用例”。
- 解决问题 - 了解有关如何解决 GitHub Copilot 常见问题的更多信息。请参阅“GitHub Copilot 故障排除”。