让聊天成为您工作区中的专家

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

@workspace 和 #codebase 有什么区别？

从概念上讲，@workspace 和 #codebase 都使您能够询问关于整个代码库的问题。但是，它们的使用方式有一些区别

• @workspace

  • 聊天参与者，专门负责回答关于代码库的问题。
  • 控制用户提示并使用代码库提供答案。
  • 无法调用其他工具。
  • 只能在提问模式下使用。
  • 示例："@workspace how can I validate a date?"

• #codebase

  • 根据用户提示执行代码库搜索，并将相关代码作为上下文添加到聊天提示中的工具。
  • 大型语言模型 (LLM) 仍保持控制，并可以将其与其他工具结合用于编辑场景。
  • 可在所有聊天模式下使用（提问、编辑和代理）。
  • 示例："add a tooltip to this button, consistent with other button #codebase"，"add unit tests and run them #codebase"

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

提示示例

• 在代码库中查找现有代码
  • "@workspace where is database connecting string configured?" - 说明了数据库连接的配置位置和方式
  • "@workspace how can I validate a date?" - 查找代码库中现有的日期验证辅助函数
  • "@workspace where are tests defined?" - 提供测试套件、测试用例以及相关引用和配置的位置
• 为复杂代码编辑制定计划
  • "@workspace how can I add a rich tooltip to a button?" - 提供了使用现有工具提示组件与按钮元素结合的计划
  • "@workspace add date validation to #selection" - 计划如何将现有日期验证应用于所选代码
  • "@workspace add a new API route for the forgot password form" - 概述了添加新路由的位置以及如何将其连接到现有代码
• 解释代码库中的更高级概念
  • "@workspace how is authentication implemented?" - 概述了身份验证流程并提供了相关代码的引用
  • "@workspace which API routes depend on this service?" - 列出了在所选代码中使用此服务的路由
  • "How do I build this #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 Chat 教程
• 了解更多关于Copilot Chat 的信息