在 VS Code 中试试 ！

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

要在聊天中提问有关整个代码库的问题，您可以在聊天提示中引用 @workspace 或 #codebase。根据问题，聊天将智能地检索相关文件和符号，然后在回答中将其作为链接和代码示例引用。

@workspace 和 #codebase 有什么区别？

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

  • @workspace

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

  • #codebase

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

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

提示

启用 github.copilot.chat.codesearch.enabled 设置，以使 #codebase 在查找相关代码片段时更有效。此设置默认启用。

提示示例

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

上下文使用哪些源？

为了回答您的问题，工作区上下文会搜索与开发人员在 VS Code 中导航代码库时使用的相同来源

  • 工作区中所有可索引文件，.gitignore 文件忽略的文件除外
  • 包含嵌套文件夹和文件名的目录结构
  • GitHub 的代码搜索索引（如果工作区是 GitHub 存储库且通过代码搜索进行了索引）
  • 工作区中的符号和定义
  • 当前选中的文本或活动编辑器中可见的文本
注意

如果您打开了被忽略文件，或者在被忽略文件中有选中的文本，则会绕过 .gitignore。

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

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

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

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

最后，GitHub Copilot 使用此上下文来回答您的问题。如果上下文太大，则仅使用上下文中最重要的部分。响应中会标记文件、文件范围和符号的引用。这使您可以直接从聊天响应链接到代码库中的相应信息。提供给 Copilot 的代码片段会在响应中列出作为参考。

管理工作区索引

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

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

Screenshot showing the workspace index status in the Copilot status menu.

远程索引

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

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

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

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

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

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

重要

远程索引需要项目在 GitHub 上有一个 git 远程仓库。请确保您也将代码推送到了 GitHub。如果 GitHub 上的代码版本相对最新，远程索引效果最佳，因此请务必定期将代码推送到 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 的示例”。但是，不要期望对整个代码库进行全面的代码分析，例如“此函数被调用了多少次？”或“修正此项目中的所有 bug”。
  • 避免假设代码之外的信息（目前），例如“谁为此文件做出了贡献？”或“总结此文件夹的评审评论”。

相关资源

06/12/2025