在 VS Code 中试用

Copilot Chat 的提示工程

本文介绍了编写提示的技巧,以从 Visual Studio Code 中的 Copilot Chat 获得更好、更相关的响应。*提示工程*或*提示设计*是讨论 AI 时常见的短语,指如何以及哪些信息被打包并发送到 AI API 终结点。

如果您是 VS Code 或 GitHub Copilot 的新手,建议您首先阅读GitHub Copilot 概述文章,或者直接进入入门教程。

有多种选项可以优化 Copilot 在内联建议和聊天方面的体验

充分利用 Copilot 内联建议

GitHub Copilot 扩展会自动提供建议,帮助您更高效地编写代码。您可以采取一些措施来帮助(“提示”)Copilot 提供最佳建议。好消息是,您现在可能已经在这样做了,因为这些措施有助于您和您的同事理解您的代码。

向 Copilot 提供上下文

当 Copilot 拥有足够的上下文来了解您正在做什么以及需要哪些帮助时,它的工作效果最佳。就像您向同事寻求特定编程任务的帮助时会提供上下文一样,您也可以对 Copilot 这样做。

打开文件

对于代码补全,Copilot 会查看编辑器中当前和已打开的文件,以分析上下文并创建适当的建议。在使用 Copilot 时,在 VS Code 中打开相关文件有助于设置此上下文,并让 Copilot 对您的项目有一个更全面的了解。

顶级注释

就像您会向同事提供简短、高级别的介绍一样,在您正在处理的文件中添加顶级注释可以帮助 Copilot 理解您正在创建的代码段的整体上下文。

适当的 include 和引用

最好手动设置您工作所需的 include 或模块引用。Copilot 可以提出建议,但您最可能清楚需要包含哪些依赖项。这也有助于让 Copilot 知道在生成建议时,您希望它使用哪些框架、库及其版本。

在下面的 TypeScript 示例中,我们想要记录 add 方法的输出。当我们没有任何 include 时,Copilot 建议使用 console.log

Copilot inline suggestion proposes Console.log when no imports in the file.

另一方面,当您添加对 Log4js 的引用时,Copilot 建议使用该框架来记录输出。

Copilot inline suggestion proposes logging using the imported logging framework.

有意义的函数名

就像一个名为 fetchData() 的方法对同事(或几个月后的您)意义不大一样,fetchData() 也不会帮助 Copilot。使用有意义的函数名有助于 Copilot 提供符合您期望的代码体。

具体且范围明确的函数注释

函数名在不过长的情况下,其描述性是有限的。函数注释可以帮助补充 Copilot 可能需要了解的详细信息。

用示例代码预热 Copilot

让 Copilot 更好地理解您需求的一个技巧是,将与您正在寻找的代码接近的示例代码复制并粘贴到您的打开编辑器中。提供一个小示例可以帮助 Copilot 生成与您想要实现的语言和任务相匹配的建议。一旦 Copilot 开始为您提供您想要且实际会使用的代码,您就可以从文件中删除示例代码。当 Copilot 默认提供旧代码建议时,这对于将其快速引导到较新库版本特别有帮助。

保持一致并保持高标准

Copilot 将会根据您的代码来生成符合现有模式的建议,因此“垃圾进,垃圾出”的格言同样适用。

始终保持高标准需要自律。特别是当您快速随意地编写代码以使其工作时,您可能希望在“黑客”模式下禁用 Copilot 补全。您可以从 Copilot 状态菜单中暂时禁用补全。通过选择 Copilot 状态栏项来调出 Copilot 状态菜单下拉列表。

Hover over the Copilot Status bar item displays "Show Copilot status menu"

从下拉列表中,您可以完全禁用补全,或者仅禁用当前活动的文件类型,例如 Markdown 文件。

Copilot Status menu dropdown with Disable Completions selected

充分利用 Copilot Chat

您还可以通过安装 GitHub Copilot Chat 扩展,通过聊天界面获得 Copilot 的帮助。

当您使用聊天与 GitHub Copilot 交互时,有几件事情可以优化您的体验。

使用聊天参与者和斜杠命令

聊天参与者旨在收集有关代码库或特定领域或技术的额外上下文。通过使用适当的参与者,Copilot Chat 可以找到并提供更好的信息发送到 Copilot 后端。例如,如果您想询问有关开放项目的问题,请使用 @workspace;如果您想了解有关 VS Code 功能和 API 的更多信息,请使用 @vscode

Asking the @vscode participant how to change the VS Code colors

当您提问时,斜杠命令可帮助 Copilot Chat 理解您的意图。您是想了解代码库(/explain),还是想解决问题(/fix),亦或是创建测试用例(/tests)?通过让 Copilot Chat 知道您正在尝试做什么,它可以调整回复以适应您的任务,并提供有用的命令、设置和代码片段。

Inline Chat slash command list

您可以使用自然语言查询来写出您的项目范围或当前任务,但使用聊天参与者和斜杠命令会更简洁明了。

在 Copilot Chat 中了解更多关于聊天参与者斜杠命令的信息。

使用聊天变量提供上下文

聊天参与者,例如 @workspace@vscode,可以提供特定领域上下文的聊天变量。您可以通过使用 # 符号在聊天提示中引用聊天变量。通过使用聊天变量,您可以更具体地说明在聊天提示中包含的上下文。

例如,使用 #<文件名>#<文件夹名>,您可以在聊天提示中引用工作区中的特定文件或文件夹。通过提供有关您正在处理的文件的上下文,这有助于使 Copilot Chat 的答案与您的代码更相关。您可以提出诸如“您能对 #package.json 提出改进建议吗?”或“如何在 #devcontainer.json 中添加扩展?”等问题。

您还可以通过使用聊天视图中的“附加上下文”按钮向聊天消息添加上下文。然后,您可以从快速选择(Quick Pick)中选择特定类型的上下文,例如当前选择、工作区中的一个或多个文件,或源代码中的一个或多个符号。

Screenshot of VS Code Copilot Chat view, showing the Attach context button and context Quick Pick.

了解更多关于在 Copilot Chat 中使用上下文变量的信息。

具体且保持简洁

当您让 Copilot 做某事时,请具体说明您的要求,并将一个大任务分解为独立的、更小的任务。例如,不要让 Copilot 创建一个使用 TypeScript 和 Pug,并具有从 MongoDB 数据库检索数据的产品页面的 Express 应用程序。相反,首先要求 Copilot 创建带有 TypeScript 和 Pug 的 Express 应用程序。接下来,要求添加一个产品页面,最后要求从数据库中检索客户数据。

当您要求 Copilot 执行特定任务时,请具体说明您想要使用的输入、输出、API 或框架。您的提示越具体,结果就越好。例如,不要说“从数据库读取产品数据”,而是说“按类别读取所有产品,以 JSON 格式返回数据,并使用 Mongoose 库”。

迭代您的解决方案

当您向 Copilot Chat 寻求帮助时,您不必拘泥于第一个响应。您可以迭代并提示 Copilot 改进解决方案。Copilot 既拥有生成代码的上下文,也拥有您当前的对话上下文。

以下是一个使用内联聊天创建计算斐波那契数列函数的示例

First response from Copilot for a function to calculate Fibonacci numbers

也许您更喜欢不使用递归的解决方案

Ask Copilot to not use recursion and new result

您甚至可以要求 Copilot 遵循编码约定或改进变量名

Ask Copilot to use better variable names and new result

即使您已经接受了一个结果,您也可以随时要求 Copilot 稍后迭代该代码。

关于 Copilot 提示的更多资源

如果您想了解更多关于高效使用 GitHub Copilot 的信息,可以查看以下视频和博客文章