查看GitHub Copilot的“说明”和“文档”功能

已完成

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

使用 GitHub Copilot 分析和解释代码

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

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

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

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

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

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

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

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

  • 计划模式:使用计划模式为文档任务创建详细的实施计划。 计划模式可以用于分析代码库、识别文档需求,并制定分步计划。 计划获得批准后,可以将其移交给代理模式以供执行。

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

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

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

使用 GitHub Copilot 生成项目文档

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

  • Ask 代理模式下的聊天视图:使用 Ask 代理分析代码库,并了解代码项目、文件和类。 Ask 代理可用于预览建议的项目文档。 根据需要查看建议并请求更新或其他详细信息。 将建议的文档插入项目文档文件(README.md)。

  • 计划代理模式下的聊天视图:为项目文档创建详细的实施计划,然后移交给代理模式以供执行。

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

重要

在代理模式下使用聊天视图时,输入的每个提示都算作一个高级请求,乘以模型的乘数。 GitHub Copilot可能会采取多个后续作来完成任务,但这些后续作不计入高级请求使用情况。 仅对你输入的提示进行计费。 使用的高级请求总数取决于你输入的提示数和选择的模型。 GitHub Copilot免费计划每月获取 50 个高级请求。 有关每个GitHub Copilot订阅的高级请求限制的更多详细信息,请查看计划说明。

概要

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