用户和工作区设置
您可以通过 Visual Studio Code 的各种设置根据您的喜好进行配置。VS Code 编辑器、用户界面和功能行为的几乎每个部分都有您可以修改的选项。
VS Code 为设置提供了不同的范围
- 用户设置 - 全局应用于您打开的任何 VS Code 实例的设置。
- 工作区设置 - 存储在您的工作区中,仅在工作区打开时应用的设置。
VS Code 将设置值存储在设置 JSON 文件中。您可以通过编辑设置 JSON 文件或使用设置编辑器来更改设置值,设置编辑器提供了用于管理设置的图形界面。
用户设置
用户设置是您用于自定义 VS Code 的个人设置。这些设置全局应用于您打开的任何 VS Code 实例。例如,如果您在用户设置中将编辑器字体大小设置为 14,那么在您计算机上的所有 VS Code 实例中都将是 14。
您可以通过以下几种方式访问用户设置
- 在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中选择首选项: 打开用户设置命令
- 在设置编辑器中选择用户选项卡(⌘, (Windows, Linux Ctrl+,))
- 在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中选择首选项: 打开用户设置 (JSON)命令
工作区设置
工作区设置特定于项目并覆盖用户设置。如果您有要应用于特定项目的特定设置,可以使用工作区设置。例如,对于后端服务器项目,您可能希望将files.exclude
设置设置为从文件资源管理器中排除node_modules
文件夹。
VS Code“工作区”通常只是您的项目根文件夹。您还可以通过称为多根工作区的功能在 VS Code 工作区中拥有多个根文件夹。获取有关VS Code 工作区的更多信息。
VS Code 将工作区设置存储在项目根目录的.vscode
文件夹中。这使得在版本控制(例如 Git)项目中轻松与他人共享设置。
您可以通过以下几种方式访问工作区设置
- 在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中选择首选项: 打开工作区设置命令
- 在设置编辑器中选择工作区选项卡(⌘, (Windows, Linux Ctrl+,))
- 在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中选择首选项: 打开工作区设置 (JSON)命令
并非所有用户设置都可用作工作区设置。例如,与更新和安全相关的应用程序范围设置不能被工作区设置覆盖。
设置编辑器
设置编辑器提供了一个图形界面来管理用户和工作区设置。要打开设置编辑器,请导航到文件 > 首选项 > 设置。或者,通过命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))使用首选项: 打开设置或使用键盘快捷方式(⌘, (Windows, Linux Ctrl+,))打开设置编辑器。
打开设置编辑器时,您可以搜索并发现您正在寻找的设置。当您使用搜索栏进行搜索时,设置编辑器会过滤设置,只显示符合您条件的设置。这使得查找设置变得快速而简单。
VS Code 会在您更改设置时直接应用更改。您可以通过设置左侧的彩色条(类似于编辑器中修改的行)来识别您修改的设置。
在下面的示例中,侧边栏位置和文件图标主题已更改。
设置旁边的齿轮图标(⇧F9 (Windows, Linux Shift+F9))打开一个上下文菜单,其中包含将设置重置为其默认值、复制设置 ID、复制 JSON 名称-值对或复制设置 URL 的选项。
设置 URL 使您能够从浏览器直接导航到设置编辑器中的特定设置。URL 格式为vscode://settings/<settingName>
,其中<settingName>
是您要导航到的设置的 ID。例如,要导航到workbench.colorTheme
设置,请使用 URL vscode://settings/workbench.colorTheme
。
设置组
设置以组的形式呈现,以便您可以快速导航到相关设置。顶部有一个常用组,其中显示了流行的自定义设置。
在以下示例中,通过在树视图中选择源代码管理来聚焦源代码管理设置。
VS Code 扩展还可以添加自己的自定义设置,这些设置在扩展部分下可见。
设置编辑器过滤器
设置编辑器搜索栏有几个过滤器,可以更轻松地管理您的设置。搜索栏右侧有一个带漏斗图标的过滤器按钮,提供选项可以轻松地向搜索栏添加过滤器。
已修改的设置
要检查您已配置的设置,搜索栏中有一个@modified
过滤器。如果设置的值与默认值不同,或者其值在相应的设置 JSON 文件中明确设置,则该设置会在此过滤器下显示。
如果您忘记是否配置了某个设置,或者因为意外配置了某个设置而导致编辑器行为不符合预期,则此过滤器会很有用。
其他过滤器
还有其他几个方便的过滤器可帮助搜索设置。在搜索栏中键入@
符号即可发现不同的过滤器。
以下是一些可用的过滤器
@ext
- 特定于扩展的设置。您提供扩展 ID,例如@ext:ms-python.python
。@feature
- 特定于功能子组的设置。例如,@feature:explorer
显示文件资源管理器的设置。@id
- 根据设置 ID 查找设置。例如,@id:workbench.activityBar.visible
。@lang
- 根据语言 ID 应用语言过滤器。例如,@lang:typescript
。有关更多详细信息,请参见特定于语言的编辑器设置。@tag
- 特定于 VS Code 系统的设置。例如,@tag:workspaceTrust
用于与工作区信任相关的设置,或@tag:accessibility
用于与辅助功能相关的设置。
搜索栏会记住您的设置搜索查询,并支持撤消/重做(⌘Z (Windows, Linux Ctrl+Z)/⇧⌘Z (Windows, Linux Ctrl+Y))。您可以使用搜索栏右侧的清除设置搜索输入按钮快速清除搜索词或过滤器。
扩展设置
已安装的 VS Code 扩展也可以贡献自己的设置,您可以在设置编辑器的扩展部分下查看这些设置。
您还可以通过扩展视图(⇧⌘X (Windows, Linux Ctrl+Shift+X))选择扩展并查看功能贡献选项卡来查看扩展的设置。
扩展作者可以在配置贡献点文档中了解有关添加自定义设置的更多信息。
设置 JSON 文件
VS Code 将设置值存储在settings.json
文件中。设置编辑器是使用户能够查看和修改存储在settings.json
文件中的设置值的用户界面。
您还可以通过在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中使用首选项: 打开用户设置 (JSON)或首选项: 打开工作区设置 (JSON)命令直接在编辑器中打开并编辑settings.json
文件。
通过指定设置 ID 和值,将设置写入 JSON。您可以通过在设置编辑器中选择设置的齿轮图标,然后选择将设置复制为 JSON操作,快速复制设置对应的 JSON 名称-值对。
settings.json
文件具有完整的 IntelliSense,可为设置和值提供智能完成和描述悬停。由于设置名称不正确或 JSON 格式不正确而导致的错误也会突出显示。
某些设置只能在settings.json
中编辑,例如工作台: 颜色自定义,并在设置编辑器中显示在 settings.json 中编辑链接。
如果您更喜欢始终直接使用settings.json
,则可以将workbench.settings.editor设置为json
。然后,文件 > 首选项 > 设置和键盘快捷键⌘, (Windows, Linux Ctrl+,)将始终打开settings.json
文件而不是设置编辑器 UI。
设置文件位置
用户 settings.json 位置
根据您的平台,用户设置文件位于此处
- Windows
%APPDATA%\Code\User\settings.json
- macOS
$HOME/Library/Application\ Support/Code/User/settings.json
- Linux
$HOME/.config/Code/User/settings.json
工作区 settings.json 位置
工作区设置文件位于根文件夹中的.vscode
文件夹下。当您将工作区设置settings.json
文件添加到您的项目或源代码管理时,该项目的设置将由该项目的所有用户共享。
对于多根工作区,工作区设置位于工作区配置文件中。
重置设置
您可以通过将鼠标悬停在设置上以显示齿轮图标,单击齿轮图标,然后选择重置设置操作来始终将设置重置为默认值。
虽然您可以通过设置编辑器单独重置设置,但您可以通过打开settings.json
并删除大括号{}
之间的条目来重置所有已更改的设置。请小心,因为无法恢复以前的设置值。
特定于语言的编辑器设置
自定义特定于语言的设置的一种方法是打开设置编辑器,按下过滤器按钮,然后选择语言选项以添加语言过滤器。或者,可以直接在搜索小部件中键入形式为@lang:languageId
的语言过滤器。出现的设置将可针对该特定语言进行配置,并将显示该语言特定的设置值(如果适用)。
当您在有语言过滤器的情况下修改设置时,该设置会针对该语言在给定范围内进行配置。例如,当在搜索小部件中有@lang:css
过滤器时修改用户范围的diffEditor.codeLens设置时,设置编辑器会将新值保存到用户设置文件中 CSS 特定的部分。
如果您在搜索小部件中输入了多个语言过滤器,当前行为是只有第一个语言过滤器会被使用。
另一种按语言自定义编辑器的方法是运行全局命令首选项: 配置特定于语言的设置(命令 ID:workbench.action.configureLanguageBasedSettings
),从命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中打开语言选择器。选择您想要的语言。然后,设置编辑器会打开并带有为所选语言设置的语言过滤器,允许您修改该语言的特定于语言的设置。但是,如果您的workbench.settings.editor设置设置为json
,则会打开settings.json
文件,并带有一个新的语言条目,您可以在其中添加适用的设置。
通过下拉菜单选择语言
现在您可以开始专门针对该语言编辑设置
或者,如果workbench.settings.editor设置为json
,现在您可以开始向您的用户设置添加特定于语言的设置
如果您打开了一个文件,并且想要为此文件类型自定义编辑器,请在 VS Code 窗口右下角的“状态栏”中选择“语言模式”。这会打开“语言模式选择器”,其中包含一个选项“配置 '语言名称' 基于语言的设置”。选择此选项将打开您的用户settings.json
,并带有语言条目,您可以在其中添加适用的设置。
特定于语言的编辑器设置始终覆盖非特定于语言的编辑器设置,即使非特定于语言的设置范围更窄。例如,特定于语言的用户设置会覆盖非特定于语言的工作区设置。
您可以像其他设置一样,将特定于语言的设置放入工作区设置中,以将它们限定在工作区范围内。如果您在用户和工作区范围内都为同一种语言定义了设置,那么它们将合并,并优先使用工作区中定义的设置。
以下示例可以粘贴到设置 JSON 文件中,以自定义typescript
和markdown
语言模式的编辑器设置。
{
"[typescript]": {
"editor.formatOnSave": true,
"editor.formatOnPaste": true
},
"[markdown]": {
"editor.formatOnSave": true,
"editor.wordWrap": "on",
"editor.renderWhitespace": "all",
"editor.acceptSuggestionOnEnter": "off"
}
}
您可以使用settings.json
中的 IntelliSense 来帮助您找到特定于语言的设置。所有编辑器设置和一些非编辑器设置都受支持。某些语言已经设置了默认的特定于语言的设置,您可以通过运行首选项: 打开默认设置命令在defaultSettings.json
中查看它们。
多语言特定编辑器设置
您可以同时为多种语言配置特定于语言的编辑器设置。以下示例展示了如何在settings.json
文件中同时为javascript
和typescript
语言自定义设置
"[javascript][typescript]": {
"editor.maxTokenizationLineLength": 2500
}
配置文件设置
您可以使用VS Code 中的配置文件来创建一组自定义设置并快速在它们之间切换。例如,它们是为特定编程语言自定义 VS Code 的好方法。
当您切换到某个配置文件时,用户设置仅限于该配置文件。当您切换到另一个配置文件时,该配置文件的用户设置将应用。通过这种方式,您可以为不同的配置文件设置不同的设置。
配置文件的用户设置 JSON 文件位于以下目录中
- Windows
%APPDATA%\Code\User\profiles\<profile ID>\settings.json
- macOS
$HOME/Library/Application\ Support/Code/User/profiles/<profile ID>/settings.json
- Linux
$HOME/.config/Code/User/profiles/<profile ID>/settings.json
<profile ID>
是配置文件的唯一标识符。对于每个覆盖设置的配置文件,都将有一个相应的配置文件设置文件。
配置文件的settings.json
文件仅在您修改该配置文件的设置时创建。
当您使用非默认配置文件时,您可以通过命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中的首选项: 打开应用程序设置 (JSON)命令访问与默认配置文件关联的settings.json
文件。
设置优先级
配置可以被不同的设置范围在多个级别上覆盖。在以下列表中,后来的范围会覆盖较早的范围
- 默认设置 - 此范围表示默认的未配置设置值。
- 用户设置 - 全局应用于所有 VS Code 实例。
- 远程设置 - 适用于用户打开的远程机器。
- 工作区设置 - 适用于打开的文件夹或工作区。
- 工作区文件夹设置 - 适用于多根工作区的特定文件夹。
- 特定于语言的默认设置 - 这些是可由扩展贡献的特定于语言的默认值。
- 特定于语言的用户设置 - 与用户设置相同,但特定于语言。
- 特定于语言的远程设置 - 与远程设置相同,但特定于语言。
- 特定于语言的工作区设置 - 与工作区设置相同,但特定于语言。
- 特定于语言的工作区文件夹设置 - 与工作区文件夹设置相同,但特定于语言。
- 策略设置 - 由系统管理员设置,这些值始终覆盖其他设置值。
设置值可以是各种类型
- 字符串 -
"files.autoSave": "afterDelay"
- 布尔值 -
"editor.minimap.enabled": true
- 数字 -
"files.autoSaveDelay": 1000
- 数组 -
"editor.rulers": []
- 对象 -
"search.exclude": { "**/node_modules": true, "**/bower_components": true }
具有基本类型和数组类型的值会被覆盖,这意味着在优先于另一个范围的范围内配置的值将代替另一个范围中的值。但是,具有对象类型的值会合并。
例如,workbench.colorCustomizations接受一个对象,该对象指定一组 UI 元素及其所需的颜色。如果您的用户设置将编辑器背景设置为蓝色和绿色
"workbench.colorCustomizations": {
"editor.background": "#000088",
"editor.selectionBackground": "#008800"
}
而您打开的工作区设置将编辑器前景设置为红色
"workbench.colorCustomizations": {
"editor.foreground": "#880000",
"editor.selectionBackground": "#00FF00"
}
当该工作区打开时,结果是这两种颜色自定义的组合,就好像您已指定
"workbench.colorCustomizations": {
"editor.background": "#000088",
"editor.selectionBackground": "#00FF00",
"editor.foreground": "#880000"
}
如果存在冲突值,例如上例中的editor.selectionBackground
,则会发生通常的覆盖行为,工作区值优先于用户值,特定于语言的值优先于非特定于语言的值。
关于多语言特定设置的注意事项
如果您正在使用多语言特定设置,请注意特定于语言的设置是合并的,并且优先级是基于完整的语言字符串(例如"[typescript][javascript]"
)而不是单个语言 ID(typescript
和javascript
)设置的。这意味着例如,"[typescript][javascript]"
工作区设置不会覆盖"[javascript]"
用户设置。
设置和安全性
某些设置允许您指定 VS Code 将运行的可执行文件以执行某些操作。例如,您可以选择集成终端应使用哪个 shell。为了增强安全性,此类设置只能在用户设置中定义,而不能在工作区范围中定义。
以下是不受工作区设置支持的设置列表
您第一次打开定义了这些设置中任何一个的工作区时,VS Code 会警告您,然后此后始终忽略这些值。
设置同步
您可以使用设置同步功能在您的 VS Code 实例之间共享用户设置。此功能允许您在各种机器上跨您的 VS Code 安装共享设置、键盘快捷方式和已安装的扩展。您可以通过设置编辑器右侧的备份和同步设置命令或帐户活动栏上下文菜单启用设置同步。
您可以在设置同步用户指南中了解有关启用和配置设置同步的更多信息。
VS Code 不会同步您的扩展到或从远程窗口,例如当您连接到 SSH、开发容器(devcontainer)或 WSL 时。
功能生命周期
功能及其对应的设置可以处于以下状态之一。根据状态,您在使用工作流中的功能或设置时可能会谨慎。
-
实验性 - 供早期采用者使用的探索性功能。这些功能将来可能会更改或删除。在设置编辑器中,这些设置带有
Experimental
标签。您还可以通过在搜索框中输入@tag:experimental
来搜索实验性设置。 -
预览 - 预览功能和设置具有最终功能,但仍可能为稳定性和完善而进行迭代。通常,预览功能默认是禁用的。在设置编辑器中,这些设置带有
Preview
标签。您还可以通过在搜索框中输入@tag:preview
来搜索预览设置。 -
稳定 - 该功能在 VS Code 中是稳定的并完全受支持。
实验性和预览功能使您可以试用新功能并提供反馈。请在我们的 VS Code 问题中分享您的反馈。
相关资源
常见问题
VS Code 提示“无法写入设置。”
如果您尝试更改设置(例如开启自动保存或选择新的颜色主题),并且看到“无法写入用户设置。请打开用户设置以纠正其中的错误/警告,然后重试。”,这意味着您的settings.json
文件格式不正确或存在错误。错误可能只是缺少逗号或设置值不正确。使用命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中的首选项: 打开用户设置 (JSON)命令打开settings.json
文件,您应该会看到错误用红色波浪线突出显示。
如何重置用户设置?
将 VS Code 重置为默认设置的最简单方法是清除您的用户settings.json
文件。您可以通过命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中的首选项: 打开用户设置 (JSON)命令打开settings.json
文件。一旦文件在编辑器中打开,删除两个大括号{}
之间的所有内容,保存文件,VS Code 将恢复使用默认值。
何时适合使用工作区设置?
如果您正在使用需要自定义设置但不希望将其应用于其他 VS Code 项目的工作区。一个很好的例子是特定于语言的 Linting 规则。
在哪里可以找到扩展设置?
通常,VS Code 扩展将其设置存储在您的用户或工作区设置文件中,并且可以通过设置编辑器 UI(首选项: 打开设置 (UI)命令)或通过您settings.json
文件中的 IntelliSense(首选项: 打开用户设置 (JSON)命令)获取。通过扩展名(例如gitlens
或python
)进行搜索可以帮助过滤设置,只显示由扩展贡献的设置。