VS Code 中 Copilot 的提示和技巧

本文提供了优化在 Visual Studio Code 中使用 GitHub Copilot 开发体验的提示和技巧。

在 VS Code 中使用 Copilot 的清单

使用以下清单以充分利用 Copilot

1. 选择合适的工具。使用针对编辑、提问或保持代码编写流畅度优化的工具。

2. 个性化 Copilot。使用自定义指令来获取符合你的风格和编码习惯的代码建议。

3. 编写有效的提示并提供上下文。获取最相关的回复。

4. 索引你的工作区。接收关于你的代码库问题的准确回复。

5. 选择你的 AI 模型。在用于快速编码或规划/推理的模型之间进行选择。

6. 复用提示。通过保存和复用团队中的特定任务提示来节省时间。

选择合适的 Copilot 工具

根据你的任务，你可以选择不同的 Copilot 工具。

通过指令文件个性化 Copilot

当 Copilot 生成代码或回答问题时，它会尝试匹配你的编码习惯和偏好，例如你使用的库或你命名变量的方式。然而，它可能并不总是有足够的上下文来有效地做到这一点。例如，如果你使用特定的框架版本，你需要在提示中提供额外的上下文。

为了增强 AI 回复，你可以使用指令文件来提供关于你团队编码习惯、工具或项目细节的上下文信息。然后你可以将这些指令附加到你的聊天提示中，或让它们自动应用。

为你的工作区启用指令文件

1. 从命令面板运行 Chat: New Instructions File 命令。

   此命令会在 .github/instructions 文件夹中创建一个 .instructions.md 文件。

2. 以 Markdown 格式将你的指令添加到文件中。例如

   # Custom instructions for Copilot
   
   ## Project context
   This project is a web application built with React and Node.js.
   
   ## Indentation
   We use tabs, not spaces.
   
   ## Coding style
   Use camelCase for variable names and prefer arrow functions over traditional function expressions.
   
   ## Testing
   We use Jest for unit testing and Playwright for end-to-end testing.
   

3. （可选）在 applyTo 元数据字段中添加一个 glob 模式，以指定指令适用于哪些文件。

   ---
   applyTo: "**/*.ts"
   ---
   Coding practices for TypeScript files.
   ...
   

获取有关在 VS Code 中使用指令文件的更多详细信息。

提示工程

你可以通过使用有效的提示来提高 Copilot 回复的质量。精心设计的提示可以帮助 Copilot 更好地理解你的需求，并生成更相关的代码建议。

• 先概括，再具体。

  Generate a Calculator class.
  Add methods for addition, subtraction, multiplication, division, and factorial.
  Don't use any external libraries and don't use recursion.
  

• 提供你想要内容的示例。

  Generate a function that takes a string and returns the number of vowels in it.
  Example:
  findVowels("hello") returns 2
  findVowels("sky") returns 0
  

• 将复杂任务分解为更简单的任务。

  不要让 Copilot 生成一个膳食计划应用，而是将其分解为更小的任务

  • 生成一个函数，该函数接受一个成分列表并返回一个食谱列表。
  • 生成一个函数，该函数接受一个食谱列表并返回一个购物清单。
  • 生成一个函数，该函数接受一个食谱列表并返回一周的膳食计划。

• 提供正确的上下文，例如代码选区、文件、终端输出等。

  例如，使用 #codebase 变量来指代整个代码库

  Where is the database connection string used in #codebase?
  

• 迭代你的提示。

  提供后续提示以细化或修改回复。例如

  • "编写一个函数来计算一个数的阶乘。"
  • "不要使用递归，并通过缓存进行优化。"
  • "使用有意义的变量名。"

• 保持聊天历史的相关性。

  Copilot 使用对话历史来提供上下文。如果过去的问答不相关，请将其从历史中删除。或者，如果你想更改上下文，请开始新会话。

获取有关提示工程的更多详细信息。

在 GitHub Copilot 文档中查找与 Copilot 一起使用的实用提示示例。

提供正确的上下文和工具

通过相关上下文丰富你的提示，以在聊天中获得更准确和相关的回复。借助正确的工具，你可以提高开发人员的生产力。

• 在代理模式下，选择工具按钮来配置你想要使用的工具，或者明确地将它们添加到你的提示中。
• 使用 #codebase 让 Copilot 通过执行代码搜索来自动查找正确的文件。
• 使用 #fetch 工具从网页获取内容，或使用 #githubRepo 在 GitHub 存储库上执行代码搜索。
• 通过使用 #<file name>、#<folder name> 或 #<symbol> 在你的提示中引用文件、文件夹或符号。
• 将文件、文件夹或编辑器选项卡拖放到聊天提示中。
• 将问题、测试失败或终端输出添加到你的聊天提示中，以获取特定场景的上下文。
• 将图片或屏幕截图添加到你的提示中，让 Copilot 分析图片。
• 在代理模式下，提示预览你的应用程序，以便直接使用内置的简单浏览器打开它。

当你使用代理模式时，Copilot 会自主为你找到相关文件和上下文。

获取有关向聊天提示添加上下文的更多详细信息。

可复用提示

提示文件使你能够将特定任务的提示及其上下文和指令保存在 Markdown 文件中。然后你可以在聊天中附加和复用该提示。如果将提示存储在工作区中，你还可以与团队共享它。

创建可复用提示

1. 使用命令面板中的 Chat: New Prompt File 命令创建提示文件。

   此命令会在工作区根目录的 .github/prompts 文件夹中创建一个 .prompt.md 文件。

2. 以 Markdown 格式描述你的提示和相关上下文。

   例如，使用此提示生成一个新的 React 表单组件。

   Your goal is to generate a new React form component.
   
   Ask for the form name and fields if not provided.
   
   Requirements for the form:
   * Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
   * Use `react-hook-form` for form state management:
   * Always define TypeScript types for your form data
   * Prefer *uncontrolled* components using register
   * Use `defaultValues` to prevent unnecessary rerenders
   * Use `yup` for validation:
   * Create reusable validation schemas in separate files
   * Use TypeScript types to ensure type safety
   * Customize UX-friendly validation rules
   

3. （可选）添加关于如何在聊天中运行提示的元数据。使用 mode 字段指定聊天模式，使用 tools 字段指定要使用的代理模式工具。

   ---
   mode: 'agent'
   tools: ['githubRepo', 'codebase']
   description: 'Generate a new React form component'
   ---
   Your goal is to generate a new React form component based on the templates in #githubRepo contoso/react-templates.
   
   Requirements for the form:
   * Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
   * Use `react-hook-form` for form state management:
   * Always define TypeScript types for your form data
   

4. 在聊天输入字段中键入 /，然后键入提示文件名，即可运行命令。

   例如，键入 /new-react-form 运行名为 new-react-form.prompt.md 的提示文件。

开始使用提示文件。

选择你的 AI 模型

Copilot 提供不同的 AI 模型供选择。有些模型针对快速编码任务进行了优化，而另一些则更适合较慢的规划和推理任务。

通过聊天输入字段中的模型选择器，选择最适合你需求的模型。

在 GitHub Copilot 文档中了解更多关于Copilot Chat 的 AI 模型的信息。

工作区索引

Copilot 使用索引快速准确地在你的代码库中搜索相关的代码片段。此索引可以由 GitHub 维护，也可以本地存储在你的机器上。

对于 GitHub 仓库，你可以使用工作区的远程索引，该索引基于GitHub 代码搜索。这使得 Copilot 能够非常快速地搜索你的整个代码库，即使代码库非常庞大。

获取有关工作区索引的更多详细信息。

相关资源

• Copilot Chat 的提示工程
• GitHub Copilot 文档中使用 GitHub Copilot 的最佳实践
• 在 VS Code 中个性化 Copilot