在 VS Code 中自定义 AI 响应

Visual Studio Code 中的聊天功能可以在您提供正确上下文的情况下，提供符合您的编码实践和项目要求的响应并生成代码。您无需在每个聊天提示中重复添加此信息，而是可以将此上下文存储在文件中，并自动将其包含在每个聊天请求中。在本文中，您将学习如何使用自定义指令和提示文件在 VS Code 中自定义 AI 响应。

在 Visual Studio Code 中自定义 AI 响应主要有三种方式

• 自定义指令：定义用于生成代码、执行代码审查或生成提交消息等任务的通用准则或规则。自定义指令描述了 AI 应如何操作（任务应如何完成）的条件。了解如何定义自定义指令。

  示例场景

  • 指定编码实践、首选技术或项目要求，以便生成的代码遵循您的标准。
  • 设置代码审查规则，例如检查安全漏洞或性能问题。
  • 提供生成提交消息或拉取请求标题和描述的指令。

• 提示文件：定义用于生成代码或执行代码审查等常见任务的可重用提示。提示文件是独立的提示，您可以直接在聊天中运行。它们描述了要执行的任务（应完成什么）。您可以选择包含关于如何执行任务的特定任务指南，或者在提示文件中引用自定义指令。了解如何创建提示文件。

  示例场景

  • 为常见的编码任务创建可重用提示，例如搭建新组件、API 路由或生成测试。
  • 定义用于执行代码审查的提示，例如检查代码质量、安全漏洞或性能问题。
  • 为复杂流程或项目特定模式创建分步指南。
  • 定义用于生成实施计划、架构设计或迁移策略的提示。

• 自定义聊天模式：定义聊天的操作方式、可使用的工具以及与代码库的交互方式。每个聊天提示都在聊天模式的边界内运行，无需为每个请求配置工具和指令。

  示例场景

  • 创建用于规划的聊天模式，其中 AI 对代码库具有只读访问权限，并且只能生成实施计划。
  • 定义研究聊天模式，其中 AI 可以访问外部资源以探索新技术或收集信息。
  • 创建前端开发人员聊天模式，其中 AI 只能生成和修改与前端开发相关的代码。

自定义指令

自定义指令使您能够描述通用准则或规则，以获得与您的特定编码实践和技术栈相符的响应。自定义指令无需在每个聊天查询中手动包含此上下文，而是自动将此信息纳入每个聊天请求中。

自定义指令的类型

VS Code 支持多种定义自定义指令的方式

您可以结合使用这些方法来定义自定义指令，并且所有指令都包含在聊天请求中。指令不按特定顺序或优先级应用，因此请确保避免文件中的指令冲突。

自定义指令示例

以下示例演示了如何使用自定义指令

---
applyTo: "**"
---
# Project general coding standards

## Naming Conventions
- Use PascalCase for component names, interfaces, and type aliases
- Use camelCase for variables, functions, and methods
- Prefix private class members with underscore (_)
- Use ALL_CAPS for constants

## Error Handling
- Use try/catch blocks for async operations
- Implement proper error boundaries in React components
- Always log errors with contextual information

---
applyTo: "**/*.ts,**/*.tsx"
---
# Project coding standards for TypeScript and React

Apply the [general coding guidelines](./general-coding.instructions.md) to all code.

## TypeScript Guidelines
- Use TypeScript for all new code
- Follow functional programming principles where possible
- Use interfaces for data structures and type definitions
- Prefer immutable data (const, readonly)
- Use optional chaining (?.) and nullish coalescing (??) operators

## React Guidelines
- Use functional components with hooks
- Follow the React hooks rules (no conditional hooks)
- Use React.FC type for components with children
- Keep components small and focused
- Use CSS modules for component styling

使用 .github/copilot-instructions.md 文件

您可以将自定义指令存储在工作区或仓库中的 .github/copilot-instructions.md 文件中，并使用 Markdown 描述您的编码实践、首选技术和项目要求。这些指令仅适用于文件所在的工作区。

VS Code 会自动将 .github/copilot-instructions.md 文件中的指令包含在每个聊天请求中，并将其应用于代码生成。

要使用 .github/copilot-instructions.md 文件

1. 将github.copilot.chat.codeGeneration.useInstructionFiles 设置为 true，以指示 VS Code 使用自定义指令文件。

2. 在工作区的根目录下创建 .github/copilot-instructions.md 文件。如果需要，请先创建 .github 目录。

3. 使用自然语言和 Markdown 格式描述您的指令。

   指令之间的空格将被忽略，因此指令可以写成一个段落，每条指令一行，或者用空行分隔以提高可读性。

使用 .instructions.md 文件

您还可以创建一或多个 .instructions.md 文件，以存储特定任务的自定义指令。例如，您可以为不同的编程语言、框架或项目类型创建指令文件。

VS Code 可以自动将指令文件添加到所有聊天请求中，或者您可以指定应自动应用指令的文件。另外，您也可以手动将指令文件附加到聊天提示中。

VS Code 支持两种指令文件作用域类型

• 工作区指令文件：仅在工作区内可用，并存储在工作区的 .github/instructions 文件夹中。
• 用户指令文件：跨多个工作区可用，并存储在当前的 VS Code 配置文件中。

指令文件结构

指令文件是带有 .instructions.md 文件后缀的 Markdown 文件。指令文件包含两个部分

• （可选）带有元数据（Front Matter 语法）的头部

  • description：指令文件的简要说明。当您在聊天视图中将鼠标悬停在指令文件上时，会显示此说明。

  • applyTo：指定一个 glob 模式，用于自动应用指令的文件。要始终包含自定义指令，请使用 ** 模式。

    例如，以下指令文件始终应用

    ---
    applyTo: "**"
    ---
    Add a comment at the end of the file: 'Contains AI-generated edits.'
    

• 带有指令内容的正文

  使用 Markdown 格式以自然语言指定自定义指令。您可以使用标题、列表和代码块来组织指令。

  您可以使用 Markdown 链接引用其他指令文件。使用相对路径引用这些文件，并确保路径基于指令文件的位置正确。

创建指令文件

要创建指令文件

1. 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行聊天：新建指令文件命令。

2. 选择应创建指令文件的位置。

   用户指令文件存储在当前配置文件文件夹中。您可以使用设置同步在多个设备之间同步您的用户指令文件。确保在设置同步：配置命令中配置提示和指令设置。

   默认情况下，工作区指令文件存储在工作区的 .github/instructions 文件夹中。使用chat.instructionsFilesLocations 设置为您的工作区添加更多指令文件夹。

3. 输入指令文件的名称。

4. 使用 Markdown 格式编写自定义指令。

   将其他工作区文件作为 Markdown 链接 ([index](../index.ts)) 或作为指令文件内的 #index.ts 引用。

从命令面板运行聊天：配置指令命令，以选择和编辑现有指令文件。此命令将在编辑器中打开指令文件，您可以在其中编辑指令和元数据。

在聊天中使用指令文件

要手动将指令文件附加到聊天提示

• 在聊天视图中，选择添加上下文 > 指令，然后从快速选择中选择指令文件。

• 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行聊天：附加指令命令，然后从快速选择中选择指令文件。

要自动应用指令文件，请在指令文件中指定 applyTo 元数据属性

• **：将指令应用于所有聊天请求。
• <glob pattern>：根据聊天上下文中的文件类型应用指令。

在设置中指定自定义指令

您可以在用户或工作区设置中配置自定义指令。这对于为代码生成以外的场景指定自定义指令很有用。VS Code 会自动将设置中的自定义指令应用于聊天请求或特定任务。

针对不同场景有特定的设置。下表列出了每种自定义指令的设置。

您可以将自定义指令定义为设置值中的文本（text 属性）或在工作区中引用外部文件（file 属性）。

以下代码片段显示了如何在 settings.json 文件中定义一组指令。

  "github.copilot.chat.codeGeneration.instructions": [
    {
      "text": "Always add a comment: 'Generated by Copilot'."
    },
    {
      "text": "In TypeScript always use underscore for private field names."
    },
    {
      "file": "general.instructions.md" // import instructions from file `general.instructions.md`
    },
    {
      "file": "db.instructions.md" // import instructions from file `db.instructions.md`
    }
  ],

定义自定义指令的技巧

• 保持指令简短且独立。每条指令都应该是一个简单明了的语句。如果您需要提供多条信息，请使用多条指令。

• 请勿在指令中引用外部资源，例如特定的编码标准。

• 将指令拆分为多个文件。这种方法对于按主题或任务类型组织指令很有用。

• 通过将指令存储在指令文件中，可以轻松地与您的团队或跨项目共享自定义指令。您还可以对文件进行版本控制，以跟踪随时间的变化。

• 在指令文件头部使用 applyTo 属性，以自动将指令应用于特定文件或文件夹。

• 在您的提示文件中引用自定义指令，以保持提示简洁且集中，并避免为不同任务重复指令。

提示文件（实验性）

提示文件是用于生成代码或执行代码审查等常见任务的可重用提示。您在 Markdown 文件中定义提示内容。提示文件是独立的提示，您可以直接在聊天中运行。您可以选择包含有关如何执行任务的指南。

VS Code 支持两种提示文件作用域类型

• 工作区提示文件：仅在工作区内可用，并存储在工作区的 .github/prompts 文件夹中。
• 用户提示文件：跨多个工作区可用，并存储在当前的 VS Code 配置文件中。

提示文件示例

以下示例演示了如何使用提示文件

---
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.

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

---
mode: 'edit'
description: 'Perform a REST API security review'
---
Perform a REST API security review:

* Ensure all endpoints are protected by authentication and authorization
* Validate all user inputs and sanitize data
* Implement rate limiting and throttling
* Implement logging and monitoring for security events

提示文件结构

提示文件是带有 .prompt.md 文件后缀的 Markdown 文件。它包含以下两个主要部分

• （可选）带有元数据（Front Matter 语法）的头部

  • mode：运行提示时使用的聊天模式：ask、edit 或 agent（默认）。
  • tools：工具（集）名称数组，指示在代理模式下可以使用哪些工具（集）。选择配置工具以从工作区中的可用工具列表中选择工具。如果在运行提示时给定工具（集）不可用，则会忽略它。
  • description：提示的简短说明。

• 带有提示内容的正文

  提示文件模仿了在聊天中编写提示的格式。这允许混合自然语言指令、附加上下文，甚至将其他提示文件链接为依赖项。您可以使用 Markdown 格式来组织提示内容，包括标题、列表和代码块。

您可以使用 Markdown 链接引用其他工作区文件、提示文件或指令文件。使用相对路径引用这些文件，并确保路径基于提示文件的位置正确。

在提示文件中，您可以使用 ${variableName} 语法引用变量。您可以引用以下变量

• 工作区变量 - ${workspaceFolder}, ${workspaceFolderBasename}
• 选择变量 - ${selection}, ${selectedText}
• 文件上下文变量 - ${file}, ${fileBasename}, ${fileDirname}, ${fileBasenameNoExtension}
• 输入变量 - ${input:variableName}, ${input:variableName:placeholder}（将值从聊天输入字段传递到提示）

创建工作区提示文件

工作区提示文件存储在您的工作区中，并且仅在该工作区中可用。

默认情况下，提示文件位于工作区的 .github/prompts 目录中。您可以使用chat.promptFilesLocations 设置指定其他提示文件位置。

要创建工作区提示文件

1. 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行聊天：新建提示文件命令。

2. 选择应创建提示文件的位置。

   默认情况下，只有 .github/prompts 文件夹可用。使用chat.promptFilesLocations 设置为您的工作区添加更多提示文件夹。

3. 输入提示文件的名称。

   另外，您也可以直接在工作区的提示文件夹中创建 .prompt.md 文件。

4. 使用 Markdown 格式编写聊天提示。

   在提示文件中，将其他工作区文件作为 Markdown 链接 ([index](../index.ts)) 或作为提示文件内的 #index.ts 引用。

   您还可以引用其他 .prompt.md 文件来创建提示层次结构。您还可以以相同的方式引用指令文件。

创建用户提示文件

用户提示文件存储在您的用户配置文件中。通过用户提示文件，您可以在多个工作区之间共享可重用提示。

要创建用户提示文件

1. 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 选择聊天：新建提示文件命令。

2. 选择用户数据文件夹作为提示文件的位置。

   如果您使用多个VS Code 配置文件，则提示文件将创建在当前配置文件的用户数据文件夹中。

3. 输入提示文件的名称。

4. 使用 Markdown 格式编写聊天提示。

   您还可以引用其他用户提示文件或用户指令文件。

在聊天中使用提示文件

您有多种选项可以运行提示文件

• 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行聊天：运行提示命令，然后从快速选择中选择一个提示文件。

• 在聊天视图中，在聊天输入字段中键入 /，后跟提示文件名。

  此选项使您可以在聊天输入字段中传递附加信息。例如，/create-react-form 或 /create-react-form: formName=MyForm。

• 在编辑器中打开提示文件，然后单击编辑器标题区域中的播放按钮。您可以选择在当前聊天会话中运行提示，或打开新的聊天会话。

  此选项对于快速测试和迭代提示文件很有用。

跨设备同步用户提示文件

VS Code 可以使用设置同步在多个设备之间同步您的用户提示文件。

要同步您的用户提示文件，请为提示和指令文件启用设置同步

1. 确保您已启用设置同步。

2. 从命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行设置同步：配置。

3. 从要同步的设置列表中选择提示和指令。

在 VS Code 中集中管理指令和提示文件

使用chat.promptFiles 设置在 VS Code 中启用或禁用指令和提示文件。

要在组织内集中启用或禁用此设置，请查看企业文档中的集中管理 VS Code 设置。

设置

相关内容

• 创建自定义聊天模式
• VS Code 聊天入门
• 配置聊天中的工具