使聊天成为你工作区内的专家

若要在聊天中就整个代码库提问，您可以在聊天提示中引用 @workspace 或 #codebase。根据问题，聊天会智能地检索相关文件和符号，并在其回答中以链接和代码示例的形式引用它们。

@workspace 和 #codebase 之间有什么区别？

从概念上讲，@workspace 和 #codebase 都使您能够就整个代码库提问。但是，它们的使用方式存在一些差异。

• @workspace

  • 聊天参与者，专门回答有关您代码库的问题。
  • 控制用户提示并使用代码库提供答案。
  • 无法调用其他工具。
  • 只能在提问模式下使用。
  • 示例："@workspace 如何验证日期？"

• #codebase

  • 一个根据用户提示执行代码库搜索并将相关代码作为上下文添加到聊天提示的工具。
  • LLM 仍保持控制权，并可以将其与其他工具结合用于编辑场景。
  • 可以在所有聊天模式下使用（提问、编辑和代理）。
  • 示例："为此按钮添加一个工具提示，使其与其他按钮 #codebase 保持一致"，"添加单元测试并运行它们 #codebase"

建议在您的聊天提示中使用 #codebase，因为它提供了更大的灵活性。

提示示例

• 在您的代码库中查找现有代码
  • "@workspace 数据库连接字符串在哪里配置？" - 解释数据库连接的配置位置和方式
  • "@workspace 如何验证日期？" - 在代码库中查找现有的日期验证辅助函数
  • "@workspace 测试在哪里定义？" - 提供测试套件、用例以及相关引用和配置的位置
• 制定复杂代码编辑计划
  • "@workspace 如何为按钮添加一个富工具提示？" - 提供使用现有工具提示组件与按钮元素结合的计划
  • "@workspace 为忘记密码表单添加一个新的 API 路由" - 概述新路由的添加位置以及如何将其与现有代码连接
• 解释代码库中的高级概念
  • "@workspace 认证是如何实现的？" - 认证流程概述及相关代码引用
  • "@workspace 哪些 API 路由依赖于此服务？" - 列出所选代码中使用该服务的路由
  • "如何构建此 #codebase？" - 列出根据文档、脚本和配置构建项目的步骤

上下文使用了哪些来源？

为了回答您的问题，工作区上下文会搜索开发者在 VS Code 中浏览代码库时会使用的相同来源。

• 工作区中所有可索引文件，但 .gitignore 文件忽略的文件除外。
• 包含嵌套文件夹和文件名的目录结构
• GitHub 的代码搜索索引，如果工作区是 GitHub 仓库并已被代码搜索索引。
• 工作区中的符号和定义
• 当前选定的文本或活动编辑器中可见的文本

@workspace 如何找到最相关的上下文

您的完整 VS Code 工作区可能太大，无法完全传递给 GitHub Copilot 以响应您的聊天提示。相反，@workspace 从不同的上下文来源中提取最相关的信息，以作为 Copilot 回答的基础。

首先，@workspace 会确定回答您问题所需的信息，这还包括对话历史、工作区结构和当前选定的代码。

接下来，它通过不同的方法收集上下文，例如通过本地搜索或使用GitHub 的代码搜索查找相关的代码片段，并使用 VS Code 的语言 IntelliSense 添加函数签名、参数等详细信息。

最后，GitHub Copilot 使用此上下文来回答您的问题。如果上下文过大，则仅使用上下文中与您问题最相关的部分。响应会使用文件、文件范围和符号的引用进行标记。这使您能够直接从聊天响应链接到代码库中的相应信息。提供给 Copilot 的代码片段在响应中列为引用。

管理工作区索引

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

您可以在状态栏中的 Copilot 状态仪表板中查看索引类型及其状态。

远程索引

如果您的代码托管在 GitHub 仓库中，您可以使用GitHub 代码搜索构建远程索引，使 AI 能够快速搜索您的代码库，即使对于大型代码库也是如此。

为您的工作区构建远程索引

1. 在 VS Code 中使用您的 GitHub 帐户登录。

2. 在命令面板 (kb(workbench.action.showCommands))) 中运行生成远程工作区索引命令。

   远程索引的构建可能需要一些时间，特别是对于大型代码库。您可以在状态栏中的 Copilot 状态仪表板中监控远程索引的状态。

   您只需构建一次远程索引。每当您推送代码更改时，GitHub 都会自动使其保持最新。

本地索引

如果您无法使用远程索引，Copilot 可以使用存储在您本地机器上的高级语义索引，以提供快速、高质量的搜索结果。目前，本地索引的文件数量限制为 2500 个可索引文件。

构建本地索引

• 项目具有少于 750 个可索引文件：Copilot 自动构建高级本地索引。

• 项目具有 750 到 2500 个可索引文件：在命令面板 (kb(workbench.action.showCommands))) 中运行生成本地工作区索引命令。此命令只需运行一次。

• 项目具有超过 2500 个可索引文件：请参阅下面的基本索引部分。

构建初始本地索引或在许多文件发生更改（例如切换 Git 分支时）时更新索引可能需要一些时间。您可以在状态栏中的 Copilot 状态仪表板中监控当前的本地索引状态。

基本索引

如果您的项目没有远程索引且具有超过 2500 个可索引文件，Copilot 会回退到使用基本索引来搜索您的代码库。此索引使用更简单的算法来搜索您的代码库，并已针对在本地处理大型代码库进行了优化。

基本索引对于许多问题应该都适用。但是，如果您发现 Copilot 在回答有关代码库的问题时遇到困难，请尝试升级到远程索引。

工作区索引包含哪些内容

Copilot 索引属于您当前项目的相关文本文件。这不限于特定的文件类型或编程语言，但是 Copilot 会自动跳过一些通常与 @workspace 问题不相关的常见文件类型，例如 .tmp 或 .out 文件。Copilot 还会排除使用 files.exclude 设置从 VS Code 中排除的任何文件，或属于 .gitignore 文件的任何文件。

Copilot 目前也不索引二进制文件，例如图像或 PDF。

使用工作区上下文的技巧

您提问的方式会显著影响上下文的质量和响应的准确性。为了优化结果，请考虑以下技巧：

• 在您的问题中要具体和详细，避免使用模糊或含糊的术语，例如“这有什么用”（其中“这”可能被解释为上一个答案、当前文件或整个项目等）。
• 在您的提示中包含可能出现在您的代码或其文档中的术语和概念。
• 审查响应中的使用的引用以确保文件相关。如有必要，迭代您的提问。
• 通过选择代码或提及聊天变量（例如 #editor、#selection 或 #<文件名>）来明确包含相关上下文。
• 响应可以从多个引用中提取信息，例如“查找没有 catch 块的异常”或“提供 handleError 如何被调用的示例”。但是，不要期望对您的代码库进行全面的代码分析，例如“此函数被调用了多少次？”或“纠正此项目中的所有错误”。
• （目前）避免假设代码之外的信息，例如“谁为此文件贡献了代码？”或“总结此文件夹的审查评论”。

相关资源

• 了解有关向聊天提示添加上下文的更多信息
• 开始使用Copilot 聊天教程
• 了解有关Copilot 聊天的更多信息