使用 GitHub Copilot 探索基本代码

简介

如果你被分配到一个不熟悉的project工作，或者你找到了一个感兴趣的开放源代码 project，你想参与其中，则需要对代码库有一些了解，然后才能开始进行更改。本指南将介绍如何用于 GitHub Copilot 聊天功能浏览基本代码并快速了解项目。

在本指南中，我们将在副驾驶聊天上使用 GitHub.com，你可以在 github.com/copilot 找到它。

可以通过以下任一方式询问副驾驶聊天代码库。

附加存储库可提供副驾驶聊天对存储库中的代码的访问权限，并且最好是在聊天期间比较或切换存储库。

注意

此功能当前处于公开预览，并可能会发生更改。

可以直接从其页面上副驾驶聊天询问GitHub存储库，而无需先附加它。这是一种快速熟悉你之前未接触过的项目的方法。

以下提示是可请求 Copilot 的问题类型的示例，可帮助你了解基本代码。

Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence.
Give me an overview of this repository: its purpose, structure, key components, and how to run it.
What are the main entry points and how do the key components fit together?
Which languages are used in this repo? Show the percentages for each language.
What are the core algorithms implemented in this repo?
What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.

这些问题是否有用将取决于你要探索的代码库。

How do I build this project?
Where is authentication handled in this codebase?
Analyze the code in this repository and tell me about the entry points for this application.
Describe the data flow in this application.
Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.

用于 Copilot 帮助你了解目录中文件或单个文件的目的。

了解目录中的文件：

Copilot 将使用目录内容作为问题上下文。

了解某个具体文件：

Copilot 将使用文件内容作为问题上下文。

对于小型文件，请询问 Copilot：Explain this file
对于大型文件，请询问以下问题：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 帮助你了解文件中的特定代码行。

了解特定代码行：

打开 GitHub，导航到存储库并打开文件。
通过单击要选择的第一行的行号，按住 Shift 并单击要选择的最后一行的行号来选择多行。
若要询问自己有关所选行的问题，请单击 Copilot 所选内容右侧的图标（）。这会显示 GitHub Copilot 聊天功能面板，其中选定行指示为问题上下文。
若要提出预定义的问题，请单击图标旁边的 Copilot 向下键，然后选择其中一个选项。
如果单击 Copilot 图标，请在聊天面板底部的提示框中键入问题，然后按 Enter。