查看 GitHub Copilot 的“解释”和“文档”功能

  • 5 分钟

GitHub Copilot 使开发人员能够更轻松地使用复杂或不熟悉的代码。 在 Visual Studio Code 中，开发人员可以直接访问分析、解释或文档代码的 GitHub Copilot 功能。

使用 GitHub Copilot 分析和解释代码

以下 GitHub Copilot 功能可用于分析和解释代码：

  • 询问模式：在询问模式下使用聊天视图分析整个工作区，并询问有关编码主题、技术概念和常规编程实践的问题。

  • 内联聊天：直接从编辑器启动内联聊天会话，询问特定代码部分。

  • 智能操作：运行“解释智能操作”功能来解释所选代码，甚至无需编写任何提示。

  • 快速聊天：提出一个快速问题，并返回到你正在执行的工作。

使用 GitHub Copilot 生成内联代码文档

以下 GitHub Copilot 功能可用于生成内联代码文档：

  • 要求模式：使用要求模式为代码文件、类或方法建议内联代码文档。 在聊天视图中查看推荐的内联文档。 在聊天对话中根据需要请求更新。 对建议的文档感到满意后，可以将建议的文档插入相应的代码文件中。

  • 编辑模式：使用编辑模式为代码文件、类或方法建议内联代码文档。 在编辑器中查看建议的文档，在建议的更新之间导航。 接受或拒绝单个建议，或根据需要修改建议。

  • 代理模式：使用代理模式为指定的代码项目、文件、类或方法自主生成内联代码文档。 让代理在文档制作过程期间或之后执行其他任务。 当代理完成分配的任务时接受或拒绝更新。

  • 内联聊天 - 使用内联聊天会话直接在代码编辑器中工作。 如果想要记录特定代码（类、方法或代码块），而无需离开编辑器，则内联聊天非常有用。 可以在提示中提供特定说明，也可以根据需要使用 /doc 左斜线命令，而无需提供特定信息。 更新显示在代码编辑器中，可以接受或拒绝。 还可以选择选项以使用或不使用更新重新运行提示。

  • 生成 Docs 智能操作：使用“生成 Docs 智能操作”为所选类、方法或代码块生成内联代码文档。 如果您没有需要提示信息的特定要求，"生成文档"智能操作非常有用。 更新显示在代码编辑器中，可以接受或拒绝。 还可以重新运行智能操作。

使用 GitHub Copilot 生成项目文档

以下 GitHub Copilot 功能可用于生成项目文档：

  • 询问模式下的聊天视图：使用询问模式分析代码库，并了解代码项目、文件和类。 使用 ask 模式预览建议的项目文档。 根据需要查看建议并请求更新或其他详细信息。 将建议的文档插入项目文档文件（README.md）。

  • 编辑模式下的聊天视图：生成项目文档文件（README.md）。

  • 代理模式下的聊天视图：生成项目文档文件的集合：创建/更新 README.md、创建/更新 UsageExamples.md，以及创建/更新 ChangeLog.md。 包括文档文件、跨引用类和方法之间的链接，并确保文档之间的一致性。

重要

在代理模式下使用聊天视图时，GitHub Copilot 可能会发出多个高级请求来完成单个任务。 高级请求可由用户发起的提示和 Copilot 代表你采取的后续操作使用。 使用的高级请求总数取决于任务的复杂性、所涉及的步骤数和所选的模型。

概要

GitHub Copilot 可帮助你快速准确地分析和记录代码。 聊天视图、内联聊天、快速聊天和智能操作功能直接在 Visual Studio Code 环境中提供不同层次的交互体验。