在 VS Code 中使用 GitHub Copilot 的最佳实践
本文介绍了在 Visual Studio Code 中使用 GitHub Copilot 的最佳实践，包括使用提示词和为 GitHub Copilot 提供正确的上下文。
“提示工程”或“提示词”是在讨论 AI 时经常听到的短语，指的是如何以及将哪些信息打包并发送到 AI API 端点。Copilot 扩展会为您完成此过程，但您可以通过提供提示来指导扩展。
如果您是 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
另一方面，当您添加对 Log4js 的引用时，Copilot 建议使用该框架来记录输出
有意义的函数名称
就像名为 fetchData() 的方法对同事（或几个月后的您）来说没有多大意义一样，fetchData() 也不会帮助 Copilot。使用有意义的函数名称有助于 Copilot 提供您想要的主体。
具体且范围明确的函数注释
函数名称在不过于冗长的情况下，只能做到这么多的描述性。函数注释可以帮助填写 Copilot 可能需要知道的详细信息。
使用示例代码来引导 Copilot
让 Copilot 步入正轨的一个技巧是将与您要查找的内容接近的示例代码复制并粘贴到您打开的编辑器中。提供一个小示例可以帮助 Copilot 生成与您要实现的语言和任务匹配的建议。一旦 Copilot 开始为您提供您想要并且实际会使用的代码，您就可以从文件中删除示例代码。当 Copilot 默认提供较旧的代码建议时，这对于快速启动 Copilot 以使用较新的库版本特别有用。
保持一致并保持高质量标准
Copilot 将会采用您的代码来生成遵循现有模式的建议，因此“输入垃圾，输出垃圾”的格言适用。
始终保持高质量标准需要自律。尤其是在您快速编码以使某些东西正常工作时，您可能希望在“黑客”模式下禁用 Copilot 完成。您可以从 Copilot 状态菜单中临时禁用完成。通过选择 Copilot 状态栏项目调出 Copilot 状态菜单下拉列表。
从下拉列表中，您可以完全禁用完成，或仅为活动文件类型（例如 Markdown 文件）禁用完成。
充分利用 Copilot 聊天
您还可以通过安装 GitHub Copilot Chat 扩展，通过 聊天界面从 Copilot 获取帮助。
当您使用聊天与 GitHub Copilot 交互时，您可以执行多项操作来优化您的体验。
使用聊天参与者和斜杠命令
聊天参与者旨在收集有关代码库或特定领域或技术的额外上下文。通过使用适当的参与者，Copilot Chat 可以查找并提供更好的信息以发送到 Copilot 后端。例如，如果您想询问有关您的打开项目的问题，请使用 @workspace，或者使用 @vscode 了解有关 VS Code 功能和 API 的更多信息。
斜杠命令帮助 Copilot Chat 理解您在提出问题时的意图。您是在学习代码库 (/explain) 吗，您需要帮助来解决问题 (/fix) 吗，还是在创建测试用例 (/tests)？通过让 Copilot Chat 知道您想要做什么，它可以调整其对您任务的回复，并提供有用的命令、设置和代码片段。
您可以使用自然语言查询写出您的项目范围或当前任务，但使用聊天参与者和斜杠命令更简洁且更明确。
在 Copilot Chat 中了解有关 聊天参与者 和 斜杠命令 的更多信息。
使用聊天变量作为上下文
聊天参与者，例如 @workspace 或 @vscode，可以贡献提供特定领域上下文的聊天变量。您可以使用 # 符号在聊天提示中引用聊天变量。通过使用聊天变量，您可以更具体地说明您在聊天提示中包含的上下文。
例如，#file 变量允许您在聊天提示中引用工作区中的特定文件。这通过提供有关您正在处理的文件的上下文，帮助使 Copilot Chat 的回答与您的代码更相关。您可以提出诸如“你能否建议改进 #file:package.json？”或“如何在 #file:devcontainer.json 中添加扩展？”之类的问题。通过使用 #file 变量，您可以从 Copilot 获得更有针对性和准确的响应。
您还可以通过使用聊天视图中的 附加上下文 按钮向您的聊天消息添加上下文。然后，您可以从快速选择中选择特定类型的上下文，例如当前选择、工作区中的一个或多个文件或源代码中的一个或多个符号。
了解有关使用 Copilot Chat 的上下文变量的更多信息。
具体且保持简单
当您要求 Copilot 执行某项操作时，请具体说明您的要求，并将大型任务分解为单独的较小任务。例如，不要要求 Copilot 创建一个使用 TypeScript 和 Pug 的 Express 应用程序，并且该应用程序具有从 MongoDB 数据库检索数据的产品页面。相反，首先要求 Copilot 创建具有 TypeScript 和 Pug 的 Express 应用程序。接下来，要求添加产品页面，最后要求从数据库检索客户数据。
当您要求 Copilot 执行特定任务时，请具体说明您要使用的输入、输出、API 或框架。您的提示越具体，结果就越好。例如，不要说“从数据库读取产品数据”，而要说“按类别读取所有产品，以 JSON 格式返回数据，并使用 Mongoose 库”。
迭代您的解决方案
当向 Copilot Chat 寻求帮助时，您不必局限于第一个响应。您可以迭代并提示 Copilot 改进解决方案。Copilot 既具有生成的代码的上下文，也具有您当前对话的上下文。
这是一个使用内联聊天创建用于计算斐波那契数的函数的示例
也许您更喜欢不使用递归的解决方案
您甚至可以要求 Copilot 遵循编码约定或改进变量名称
即使您已经接受了结果，您仍然可以随时要求 Copilot 稍后迭代代码。
有关 Copilot 提示的更多资源
如果您想了解更多关于高效使用 GitHub Copilot 的信息，您可以关注以下视频和博客文章