跳至主要内容

使用 GitHub Copilot 探索代码库

GitHub Copilot Chat 可以帮助您了解代码库的内容、结构和功能。

简介

如果您被指派去处理一个您不熟悉的项目——或者您发现了一个有趣的开源项目并希望贡献代码——在开始进行更改之前,您需要对代码库有一定的了解。本指南将向您展示如何使用 GitHub Copilot Chat 来探索代码库并快速了解项目。

使用 Copilot Chat

在本指南中,我们将在 GitHub.com 上使用 Copilot Chat,您可以访问 github.com/copilot

附加代码库

在 Copilot Chat 能帮助您之前,您需要附加想要探索的代码库。

  1. 在 GitHub 上,前往 github.com/copilot
  2. 在文本框中,点击 添加仓库、文件和空间,然后点击 仓库
  3. 搜索并选择您想要探索的仓库。

Copilot Chat 现在可以访问该仓库中的代码,您可以开始就此提问。

示例提示

下面的提示示例展示了您可以向 Copilot 提问以了解代码库的各种问题类型。

常规问题

  • 基于此仓库中的代码,请为我提供代码库架构的概览,并提供证据。

  • 此仓库使用了哪些语言?请显示每种语言的比例。

  • 此仓库实现了哪些核心算法?

  • 此仓库使用了哪些设计模式?请简要说明每个发现的模式,并提供该仓库中使用该模式的代码示例及文件链接。

具体问题

这些问题是否有用取决于您正在探索的代码库。

  • 我该如何构建此项目?

  • 此代码库的身份验证在哪里处理?

  • 分析此仓库中的代码,并告诉我该应用程序的入口点。

  • 描述该应用程序的数据流。

  • 分析此仓库中的代码,并告诉我所使用的应用层安全机制。请提供参考。

了解目录中的文件

使用 Copilot 帮助您了解目录中或单个文件的用途。

了解目录中的文件

  1. 在 GitHub.com 上导航至该目录。

  2. 在页面右上角,点击 Copilot 图标()打开 Copilot Chat。

    Copilot 将把目录内容作为您提问的上下文。

  3. 向 Copilot 提问:Explain the files in this directory

了解特定文件

  1. 在 GitHub.com 上打开该文件。

  2. 在页面右上角,点击 Copilot 图标()打开 Copilot Chat。

    Copilot 将把文件内容作为您提问的上下文。

  3. 对于小文件,向 Copilot 提问:Explain this file

  4. 对于大文件,请提问:Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.

了解特定代码行

使用 Copilot 帮助您了解文件中的特定代码行。

了解特定代码行

  1. 在 GitHub 上,导航到一个仓库并打开文件。

  2. 通过点击想要选择的第一行的行号,然后按住 Shift 并点击最后一行的行号来选择这些行。

  3. 要对所选行提出自己的问题,请点击 Copilot 图标()位于您选择的右侧。这会显示 GitHub Copilot Chat 面板,并将所选行作为您问题的上下文。

  4. 要提出预定义的问题,请点击 Copilot 图标旁的向下箭头按钮,然后选择其中一个选项。

    Screenshot of the Copilot buttons, highlighted with a dark orange outline, to the right of some selected code.

  5. 如果您点击了 Copilot 图标,请在聊天面板底部的提示框中输入问题并按 Enter

了解特定文件或符号

使用 Copilot 帮助您了解代码库中某个特定文件或符号的用途。符号指代码中的命名实体,如函数、类或变量。

  1. 在 GitHub 上,导航到一个仓库并打开文件。

  2. 在文件顶部,点击 Copilot 图标()打开 Copilot Chat。

    Copilot 将在分屏中显示文件内容,作为您提问的上下文。

  3. 如果您想询问特定符号,请在文件中高亮该符号。

  4. 在提示框中,输入有关文件或高亮符号的问题,然后按 Enter

    Copilot 在聊天面板中回复。

    提示

    当仓库的语义代码搜索索引是最新的时,Copilot 在仓库上下文中回答此类自然语言问题的能力会得到优化。更多信息,请参阅 为 GitHub Copilot 索引仓库

了解提交记录

熟悉项目的一个好方法是查看近期的工作进展。您可以通过浏览最近的提交来实现。

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在仓库主页的文件列表上方,点击 提交

    Screenshot of the main page for a repository. A clock icon and "178 commits" is highlighted with an orange outline.

  3. 点击提交信息以显示该提交的差异视图。

  4. 在 Copilot Chat 面板中输入:What does this commit do?

  5. 如有必要,您可以继续输入:Explain in more detail

使用 Insights 选项卡

除了使用 Copilot 帮助您熟悉项目外,您还可以使用 GitHub.com 上的 Insights 选项卡。这为您提供仓库的高级概览。

欲了解更多信息,请参阅 使用 Pulse 查看仓库活动概览查看项目贡献者

延伸阅读

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