现已推出!阅读关于 11 月的新功能和修复。

什么是 VS Code "工作区"?

Visual Studio Code 工作区是在 VS Code 窗口(实例)中打开的一个或多个文件夹的集合。在大多数情况下,您将打开一个文件夹作为工作区。但是,根据您的开发工作流程,您可以使用称为多根工作区的高级配置来包含多个文件夹。

工作区的概念使 VS Code 能够

  • 配置仅适用于特定文件夹而不适用于其他文件夹的设置。
  • 持久化仅在该工作区上下文中有效的任务调试器启动配置。
  • 存储和恢复与该工作区关联的 UI 状态(例如,打开的文件)。
  • 仅针对该工作区选择性地启用或禁用扩展。

您可能会在 VS Code 文档、问题和社区讨论中看到交替使用术语“文件夹”和“工作区”。可以将工作区视为具有额外的 VS Code 知识和功能的项目的根目录。

注意:也可以在没有工作区的情况下打开 VS Code。例如,当您从平台的 文件 菜单中选择文件打开新的 VS Code 窗口时,您将不在工作区内。在此模式下,VS Code 的某些功能会减少,但您仍然可以打开文本文件并对其进行编辑。

如何打开 VS Code "工作区"?

您可以使用 文件 > 打开文件夹... 菜单打开工作区,然后选择一个文件夹。

或者,如果您从终端启动 VS Code,则可以将文件夹的路径作为 code 命令的第一个参数传递以打开。例如,使用以下命令打开当前文件夹 (.) 并使用 VS Code

code .

单文件夹工作区

除了使用 VS Code 打开文件夹外,您无需执行任何操作即可使文件夹成为 VS Code 工作区。打开文件夹后,VS Code 会自动跟踪配置,例如您打开的文件或编辑器布局。当您在 VS Code 中重新打开该文件夹时,编辑器将与您上次离开时的状态相同。

您还可以添加其他特定于文件夹的配置,例如特定于工作区的设置(与全局用户设置相对)、任务定义调试启动文件(请参见下方的工作区设置部分)。

Single-folder workspace

在 VS Code 中打开的单文件夹工作区

多根工作区

多根工作区是 VS Code 的一项高级功能,允许您配置多个不同的文件夹以成为同一工作区的一部分。您不是打开一个文件夹作为工作区,而是打开一个列出工作区所有文件夹的 <名称>.code-workspace JSON 文件。例如

{
  "folders": [
    {
      "path": "my-folder-a"
    },
    {
      "path": "my-folder-b"
    }
  ]
}

Multi-root workspace

在 VS Code 中打开的多根工作区

注意:打开文件夹与打开 .code-workspace 文件的视觉差异可能很微妙。为了提示您已打开 .code-workspace 文件,用户界面的某些区域(例如,文件资源管理器的根目录)会在名称旁边显示额外的 (工作区) 后缀。

未命名的多根工作区

您可以灵活地在工作区中添加或删除文件夹。首先在 VS Code 中打开一个文件夹,然后根据需要添加更多文件夹。

File Explorer context menu, highlighting options to add or remove folders to the workspace

用于在工作区中添加或删除文件夹的文件资源管理器上下文菜单

除非您已打开 .code-workspace 文件,否则当您第一次将第二个文件夹添加到工作区时,VS Code 会自动创建一个未命名的工作区。在后台,VS Code 会自动为您维护一个 untitled.code-workspace 文件,其中包含您当前会话中的所有文件夹和工作区设置。该工作区保持未命名状态,直到您决定将其保存到磁盘。

Untitled multi-root workspace

在 VS Code 中打开的未命名多根工作区

注意:未命名的工作区和已保存的工作区之间没有任何区别,只是为了方便起见,自动为您创建了未命名的工作区,并且会一直恢复,直到您保存它。当您关闭打开了未命名工作区的窗口时,VS Code 会自动删除未命名的工作区(在征求您的确认后)。

工作区设置

工作区设置使您能够在打开的工作区的上下文中配置设置。工作区设置始终会覆盖全局用户设置。它们以 JSON 文件形式物理存储,其位置取决于您是将文件夹打开为工作区,还是打开 .code-workspace 文件。

有关设置范围及其文件位置的全面说明,请参阅设置文档。

单文件夹工作区设置

当您打开文件夹作为工作区时,工作区设置存储在 .vscode/settings.json 中。

Single-folder workspace settings

当打开文件夹作为工作区时的设置编辑器

多根工作区设置

当您打开 .code-workspace 作为工作区时,所有工作区设置都会添加到 .code-workspace 文件中。

您仍然可以配置每个根文件夹的设置,并且设置编辑器将显示第三个设置范围,称为 文件夹设置

Multi-root settings

当打开多根工作区时的设置编辑器

每个文件夹配置的设置会覆盖在 .code-workspace 中定义的设置。

工作区任务和启动配置

工作区设置特定于工作区类似,任务和启动配置也可以限定到工作区。

根据您是将文件夹打开为工作区还是打开 .code-workspace 文件,工作区任务和启动配置的位置位于 .vscode 文件夹内,或位于 .code-workspace 文件内。此外,即使您打开了 .code-workspace 文件,始终可以在文件夹级别定义任务和启动配置。

有关如何在 VS Code 中使用任务和启动配置的更全面概述,请参阅任务调试章节。

常见问题

多根工作区比文件夹有什么好处?

最明显的优势是,多根工作区允许您使用可能未存储在磁盘上的同一父文件夹内的多个项目。您可以从任何位置选择文件夹以添加到工作区。

即使您主要在基于单文件夹的项目中工作,也可以从使用 .code-workspace 文件中受益。您可以在文件夹内存储多个 .code-workspace 文件,以根据场景提供项目某些方面的范围限定的文件夹视图(例如,client.code-workspaceserver.code-workspace,以从文件资源管理器中过滤掉不相关的文件夹)。由于 .code-workspace 文件支持 folders 部分的相对路径,因此这些工作区文件适用于每个人,与文件夹的存储位置无关。

最后,如果对于某些项目,您想要应用相同的工作区设置或任务/启动配置集,请考虑将这些内容添加到 .code-workspace 文件中,并在该工作区中添加或删除这些文件夹。

为什么 VS Code 会在重启时恢复所有未命名的工作区?

未命名的工作区旨在让您明确决定是否要保留它们。首次创建未命名的工作区时,VS Code 会将指定的文件夹添加到工作区文件中,并添加所有现有的工作区设置。这些用户数据始终会恢复并显示在 VS Code 窗口中,直到未命名的工作区被保存或删除。

如何删除未命名的工作区?

您可以通过关闭其窗口并拒绝保存未命名工作区的提示来删除未命名的工作区。

我可以使用没有文件夹的多根工作区吗?

可以将 .code-workspace 文件中的 folders 部分留空,这样您最终会得到一个不显示任何根文件夹的 VS Code 实例。在这种情况下,您仍然可以存储工作区设置,甚至任务或启动配置。

VS Code 支持项目或解决方案吗?

VS Code 没有像其他开发工具(例如 Visual Studio IDE)中定义的“项目”或“解决方案”的概念。您可能会在 VS Code 文档中看到“项目”一词,但它通常指的是“您正在处理的事物”。根据您的编程语言或框架,工具集本身可能会支持一种称为“项目”的东西,以帮助定义构建配置或枚举包含的文件。