GitHub Copilot 快速入门

快速了解如何使用 GitHub Copilot。

本文内容

简介

您可以使用 Copilot 获取与代码相关的问题的答案，例如如何最好地编写某些代码、如何修复错误或其他人代码的工作原理。有关 Copilot 可以执行的所有操作的完整详细信息，请参阅“什么是 GitHub Copilot？”。

如果您有权访问 Copilot Workspace，则当您在 GitHub 网站上编辑拉取请求中的文件时，Copilot 还可以通过为您提供代码补全建议来帮助您。有关 Copilot Workspace 的更多信息，请参阅“使用 Copilot 帮助您处理拉取请求”。

使用 Copilot 的说明因您使用 Copilot 的位置而异。此版本的快速入门适用于 GitHub。点击上面的选项卡以获取在其他环境中使用 Copilot 的说明。

注册 GitHub Copilot

开始免费试用

如果您尚未访问 GitHub Copilot，则可以在您的个人 GitHub 帐户上为 GitHub Copilot Individual 设置免费试用版或订阅。有关更多信息，请参阅“GitHub Copilot 订阅计划”。

提出您的第一个问题

  1. 在 GitHub 上，导航到存储库并打开文件。

  2. 点击文件视图右上方的 Copilot 图标（）。

    Screenshot of the Copilot button, highlighted with a dark orange outline, at the top of the file view.

  3. 在聊天面板底部的“询问 Copilot”框中键入问题，然后按Enter。

    例如，您可以输入

    • 解释此文件。
    • 我该如何改进此代码？
    • 我如何测试此代码？

    Copilot 在面板中响应您的请求。

  4. 您可以通过提出后续问题来继续对话。例如，您可以键入“告诉我更多”以让 Copilot 扩展其上次评论。

您可以提出的其他问题

您可以在 GitHub 中使用 GitHub Copilot Chat 执行更多操作，例如

  • 询问有关软件开发的一般问题
  • 询问有关存储库的探索性问题
  • 询问有关知识库的问题
  • 了解拉取请求中的更改
  • 询问有关特定问题或提交的问题

有关更多信息，请参阅“在 GitHub 中询问 GitHub Copilot 问题”。

后续步骤

GitHub Copilot 在您在编辑器中键入时提供代码建议。您还可以向 Copilot 询问与代码相关的疑问，例如如何最好地编写某些代码、如何修复错误或其他人代码的工作原理。有关 Copilot 可以执行的所有操作的完整详细信息，请参阅“什么是 GitHub Copilot？”。

使用 Copilot 的说明因您使用 Copilot 的位置而异。此版本的快速入门适用于 Windows 终端。点击上面的选项卡以获取在其他环境中使用 Copilot 的说明。

注册 GitHub Copilot

开始免费试用

如果您尚未访问 GitHub Copilot，则可以在您的个人 GitHub 帐户上为 GitHub Copilot Individual 设置免费试用版或订阅。有关更多信息，请参阅“GitHub Copilot 订阅计划”。

先决条件

在终端聊天中使用 Copilot

安装 Windows 终端 Canary 后，您可以在终端聊天中使用 Copilot 询问与命令行相关的疑问。

  1. 从下拉菜单中打开**设置**。

    Screenshot of the dropdown menu in the Windows Terminal with the Settings item highlighted.

  2. 转到**终端聊天（实验性）**设置。

    Screenshot of the Settings menu in the Windows Terminal with the Terminal Chat (Experimental) item highlighted.

  3. 在**服务提供商**下，选择**GitHub Copilot** 并**通过 GitHub 身份验证**以登录。

与 GitHub Copilot 聊天

注意

如果您通过您的组织访问 GitHub Copilot，则如果您的组织所有者在 CLI 中禁用了 GitHub Copilot，则您将无法在 Windows 终端中使用 GitHub Copilot。请参阅“管理组织中的 Copilot 策略”。

  1. 从下拉菜单中打开**终端聊天（实验性）**。

  2. 在终端聊天聊天窗口中，键入如何列出我的目录中的所有 markdown 文件，然后按Enter。

    Copilot 的答案显示在您的问题下方。

  3. 点击答案将其插入命令行。

后续步骤

GitHub Copilot 在您在编辑器中键入时提供代码建议。您还可以向 Copilot 询问与代码相关的疑问，例如如何最好地编写某些代码、如何修复错误或其他人代码的工作原理。有关 Copilot 可以执行的所有操作的完整详细信息，请参阅“什么是 GitHub Copilot？”。

使用 Copilot 的说明因您使用 Copilot 的位置而异。此版本的快速入门适用于 Visual Studio Code。点击上面的选项卡以获取在其他环境中使用 Copilot 的说明。

注册 GitHub Copilot

开始免费试用

如果您尚未访问 GitHub Copilot，则可以在您的个人 GitHub 帐户上为 GitHub Copilot Individual 设置免费试用版或订阅。有关更多信息，请参阅“GitHub Copilot 订阅计划”。

先决条件

与 GitHub Copilot 聊天

安装 GitHub Copilot 扩展后，您可以向 Copilot 询问与代码相关的疑问。

注意

如果您通过您的组织访问 GitHub Copilot，但您的组织所有者已禁用聊天功能，则您将无法使用 GitHub Copilot Chat。请参阅“在您的组织中管理 Copilot 的策略”。

  1. 打开一个现有的代码文件。

  2. 从活动栏打开聊天视图。

    Screenshot of the Chat icon in the VS Code Activity Bar.

  3. 在聊天视图底部，在聊天输入字段中，键入：explain this file。

  4. 按 Enter。

    Copilot 在聊天视图中回复。

  5. 在编辑器中，选择一个或多个未注释的代码行。

  6. 在聊天输入字段中，键入：add comments to these lines。

  7. 如果您喜欢 Copilot 建议的注释，请将鼠标悬停在聊天视图中的建议代码上，然后单击“在光标处插入”图标以使用建议的代码替换选定的代码行。

    Screenshot of the "Insert at Cursor" icon in the chat view.

获取您的第一个代码补全建议

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

  1. 打开 Visual Studio Code。

  2. 在 Visual Studio Code 中，创建一个新的 JavaScript（*.js）文件。

  3. 在 JavaScript 文件中，键入以下函数头。

    JavaScript
    function calculateDaysBetweenDates(begin, end) {

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

  4. 要接受建议，请按 Tab。

后续步骤

GitHub Copilot 在您在编辑器中键入时提供代码建议。您还可以向 Copilot 询问与代码相关的疑问，例如如何最好地编写某些代码、如何修复错误或其他人代码的工作原理。有关 Copilot 可以执行的所有操作的完整详细信息，请参阅“什么是 GitHub Copilot？”。

使用 Copilot 的说明因您使用 Copilot 的位置而异。此快速入门版本的说明适用于 Visual Studio。单击上面的选项卡以获取有关在其他环境中使用 Copilot 的说明。

注册 GitHub Copilot

开始免费试用

如果您尚未访问 GitHub Copilot，则可以在您的个人 GitHub 帐户上为 GitHub Copilot Individual 设置免费试用版或订阅。有关更多信息，请参阅“GitHub Copilot 订阅计划”。

先决条件

与 GitHub Copilot 聊天

安装 GitHub Copilot 扩展后，您可以向 Copilot 询问与代码相关的疑问。

注意

如果您通过您的组织访问 GitHub Copilot，但您的组织所有者已禁用聊天功能，则您将无法使用 GitHub Copilot Chat。请参阅“在您的组织中管理 Copilot 的策略”。

  1. 打开一个现有的代码文件。

  2. 在 Visual Studio 菜单栏中，单击视图，然后单击GitHub Copilot Chat。

  3. 在 Copilot Chat 窗口中，键入what does this file do，然后按 Enter。

    Copilot 的答案显示在您的问题下方。

  4. 在编辑器中选择一行代码。

  5. 在 Copilot Chat 窗口中，键入explain this line，然后按 Enter。

获取您的第一个代码补全建议

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

  1. 打开 Visual Studio。

  2. 在 Visual Studio 中，创建一个新的 JavaScript（*.js）文件。

  3. 在 JavaScript 文件中，键入以下函数头。

    JavaScript
    function calculateDaysBetweenDates(begin, end) {

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

  4. 要接受建议，请按 Tab。

后续步骤

GitHub Copilot 在您在编辑器中键入时提供代码建议。您还可以向 Copilot 询问与代码相关的疑问，例如如何最好地编写某些代码、如何修复错误或其他人代码的工作原理。有关 Copilot 可以执行的所有操作的完整详细信息，请参阅“什么是 GitHub Copilot？”。

使用 Copilot 的说明因您使用 Copilot 的位置而异。此快速入门版本的说明适用于 JetBrains IDE。单击上面的选项卡以获取有关在其他环境中使用 Copilot 的说明。

注册 GitHub Copilot

开始免费试用

如果您尚未访问 GitHub Copilot，则可以在您的个人 GitHub 帐户上为 GitHub Copilot Individual 设置免费试用版或订阅。有关更多信息，请参阅“GitHub Copilot 订阅计划”。

先决条件

与 GitHub Copilot 聊天

安装 GitHub Copilot 插件后，您可以向 Copilot 提问与代码相关的疑问。

注意

如果您通过您的组织访问 GitHub Copilot，但您的组织所有者已禁用聊天功能，则您将无法使用 GitHub Copilot Chat。请参阅“在您的组织中管理 Copilot 的策略”。

  1. 打开一个现有的代码文件。

  2. 通过单击 JetBrains IDE 窗口右侧的Copilot Chat图标打开 Copilot Chat 窗口。

    Screenshot of the Copilot Chat icon in the Activity Bar.

  3. 在 Copilot Chat 窗口中，键入what does this file do，然后按 Enter。

    Copilot 的答案显示在您的问题下方。

  4. 在编辑器中选择一行代码。

  5. 在 Copilot Chat 窗口中，键入explain this line，然后按 Enter。

获取您的第一个代码补全建议

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

  1. 在您的 JetBrains 编辑器中，创建一个新的 JavaScript（*.js）文件。

  2. 在 JavaScript 文件中，键入以下函数头。

    JavaScript
    function calculateDaysBetweenDates(begin, end) {

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

  3. 要接受建议，请按 Tab。

后续步骤