尝试以扩展 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 理解你正在创建的各个部分的整体上下文。

适当的包含和引用

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

在下面的 TypeScript 示例中,我们想要记录 add 方法的输出。当我们没有任何包含时,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 互动时,有几件事可以做来优化你的体验。

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

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

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 中添加一个扩展?”之类的问题。

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

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

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

具体并保持简单

当你要求 Copilot 做某事时,要具体说明你的要求,并将一个大任务分解成多个独立的小任务。例如,不要要求 Copilot 创建一个使用 TypeScript 和 Pug 的 Express 应用,并且有一个从 MongoDB 数据库检索数据的产品页面。而是,首先要求 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 的信息,可以关注这些视频和博客文章