开始使用 GitHub Copilot

关于 GitHub Copilot 和 Visual Studio Code

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

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

先决条件

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

• 若要在 Visual Studio Code 中使用 GitHub Copilot，必须安装 Visual Studio Code。 有关详细信息，请参阅 Visual Studio Code 下载页面。

安装 Visual Studio Code 扩展

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

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 窗口底部面板中的钟形图标。

     

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

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

查看第一个建议

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 可以提供多个建议。 可以选择要使用的建议，或拒绝所有建议。

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

2. 在 JavaScript 文件中，键入以下函数标头。 GitHub Copilot 将向你显示建议。

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

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

   OS	查看下一个建议	查看上一个建议
   macOS	Option (⌥) 或 Alt+]	Option (⌥) 或 Alt+[
   Windows	Alt+]	Alt+[
   Linux	Alt+]	Alt+[

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

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

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

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

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

2. 在 JavaScript 文件中，键入以下函数标头。 GitHub Copilot 将向你显示建议。

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. 若要打开具有多个其他选项的新选项卡，请按 Ctrl+Enter。

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

从注释生成代码建议

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

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

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

   JavaScript

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

使用框架

还可以使 GitHub Copilot 为 API 和框架生成建议。 以下示例使用 GitHub Copilot 创建将返回当前时间的简单 Express 服务器。

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

2. 在 JavaScript 文件中，键入以下注释，然后按 Enter。 GitHub Copilot 将建议 Express 应用的实现。

   JavaScript

   // Express server on port 3000
   

3. 要接受每行，请按下 Tab，然后按下 Enter。

4. 键入以下注释，然后按下 Enter。 GitHub Copilot 将建议默认处理程序的实现。

   JavaScript

   // Return the current time
   

5. 若要接受每行，请按 Tab。

启用或禁用 GitHub Copilot

可以在 Visual Studio Code 中启用或禁用 GitHub Copilot。 Visual Studio Code 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。 启用后，图标的背景色将与状态栏颜色相匹配。 禁用后，图标的背景色将与状态栏颜色形成对比。

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

   

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

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

延伸阅读

• GitHub Copilot