在 VS Code 中试试

什么是 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 文档中看到“项目”一词,但这通常指的是“你正在处理的事物”。根据你使用的编程语言或框架,工具集本身可能会支持某种称为“项目”的概念,以帮助定义构建配置或枚举包含的文件。