Visual Studio Code 键盘快捷键

Visual Studio Code 允许你直接通过键盘执行大多数任务。本文介绍了如何修改 VS Code 附带的默认键盘快捷键。

键盘快捷方式编辑器

VS Code 通过“键盘快捷键”编辑器提供了丰富的键盘快捷键编辑体验。该编辑器列出了所有可用命令（无论是否带有键盘快捷键），并允许你使用可用操作更改、删除或重置它们的键盘快捷键。要查找命令或键盘快捷键，请使用搜索框并输入命令或快捷键来过滤列表。

要打开“键盘快捷键”编辑器，请选择 文件 > 首选项 > 键盘快捷键 菜单，或在命令面板中使用 首选项：打开键盘快捷键 命令 (⌘K ⌘S (Windows、Linux Ctrl+K Ctrl+S))。

为 UI 操作自定义快捷键

要为 UI 操作自定义键盘快捷键，请右键单击工作台中的任何操作项，然后选择 配置按键绑定。这将打开“键盘快捷键”编辑器，并筛选到相应的命令。如果该操作具有 when 子句，它会自动包含在内，从而使你可以更轻松地按照需要设置键盘快捷键。

键映射扩展

键映射扩展修改 VS Code 快捷键以匹配其他编辑器的快捷键，这样你就不需要学习新的键盘快捷键。

选择 文件 > 首选项 > 从...迁移键盘快捷键 菜单可获取热门键映射扩展列表。在 Marketplace 中也有一个 键映射类别 的扩展。

键盘快捷键参考

我们有默认键盘快捷键的可打印版本。选择 帮助 > 键盘快捷键参考 以显示适合打印的精简 PDF 版本，方便参考。

以下链接提供了访问三个特定于平台的版本（美国英语键盘）

• Windows
• macOS
• Linux

检测键盘快捷键冲突

如果你安装了许多扩展或修改了键盘快捷键，可能会出现键盘快捷键冲突，即同一个键盘快捷键映射到多个命令。这可能会导致令人困惑的行为，尤其是在你在编辑器中移动时，不同的键盘快捷键会进出范围。

右键单击键盘快捷键列表中的某个项，然后选择 显示相同的按键绑定 以查看所有具有相同键盘快捷键的条目。

键盘快捷键故障排除

要对键盘快捷键问题进行故障排除，你可以执行命令 开发人员：切换键盘快捷键故障排除。这将激活已分派键盘快捷键的日志记录，并打开“输出”面板，其中包含相应的日志文件。

然后你可以按下你想要的键盘快捷键，并检查 VS Code 检测到的键盘快捷键以及调用的命令。

例如，在 macOS 上的代码编辑器中按 cmd+/ 时，日志输出将为

[KeybindingService]: / Received  keydown event - modifiers: [meta], code: MetaLeft, keyCode: 91, key: Meta
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: MetaLeft, keyCode: 57 ('Meta')
[KeybindingService]: \ Keyboard event cannot be dispatched.
[KeybindingService]: / Received  keydown event - modifiers: [meta], code: Slash, keyCode: 191, key: /
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: Slash, keyCode: 85 ('/')
[KeybindingService]: | Resolving meta+[Slash]
[KeybindingService]: \ From 2 keybinding entries, matched editor.action.commentLine, when: editorTextFocus && !editorReadonly, source: built-in.

在示例日志中，第一个 keydown 事件针对 MetaLeft 键 (cmd)，无法分派。第二个 keydown 事件针对 Slash 键 (/)，并分派为 meta+[Slash]。有两个键盘快捷键条目映射自 meta+[Slash]，匹配的是命令 editor.action.commentLine，它具有 when 条件 editorTextFocus && !editorReadonly，并且是一个内置键盘快捷键条目。

查看已修改的键盘快捷键

要将列表筛选为仅显示你已修改的快捷键，请在 更多操作 (...) 菜单中选择 显示用户按键绑定 命令。这会将 @source:user 筛选器应用于 键盘快捷键 编辑器（来源 为“用户”）。

高级自定义

VS Code 在 keybindings.json 文件中跟踪你自定义的键盘快捷键。对于高级自定义，你还可以直接修改 keybindings.json 文件。

要打开 keybindings.json 文件

• 打开 键盘快捷键 编辑器，然后选择编辑器标题栏右侧的 打开键盘快捷键 (JSON) 按钮。

  

• 或者，在命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中使用 打开默认键盘快捷键 (JSON) 命令。

键盘规则

VS Code 中的键盘快捷键配置也称为键盘规则。每个规则包含以下属性

• key：描述按下的按键，例如 ⌘F (Windows、Linux Ctrl+F)。
• command：要执行的 VS Code 命令标识符，例如 workbench.view.explorer 以打开资源管理器视图。
• when：（可选）包含一个布尔表达式的子句，该表达式根据当前上下文进行评估。

和弦（两个单独的按键操作）通过用空格分隔两个按键来描述。例如，Ctrl+K Ctrl+C。

按下按键时，将应用以下评估规则

• 规则从下到上进行评估。
• 接受第一个匹配 key 和 when 子句的规则。
• 如果找到规则，则不再处理其他规则。
• 如果找到规则并且设置了 command，则执行该 command。

额外的 keybindings.json 规则在运行时附加到默认规则的底部，因此允许它们覆盖默认规则。VS Code 会监视 keybindings.json 文件，因此在 VS Code 运行时编辑它将实时更新规则。

键盘快捷键的分派是通过分析以 JSON 表示的规则列表来完成的。这里有一些例子

// Keyboard shortcuts that are active when the focus is in the editor
{ "key": "home",            "command": "cursorHome",                  "when": "editorTextFocus" },
{ "key": "shift+home",      "command": "cursorHomeSelect",            "when": "editorTextFocus" },

// Keyboard shortcuts that are complementary
{ "key": "f5",              "command": "workbench.action.debug.continue", "when": "inDebugMode" },
{ "key": "f5",              "command": "workbench.action.debug.start",    "when": "!inDebugMode" },

// Global keyboard shortcuts
{ "key": "ctrl+f",          "command": "actions.find" },
{ "key": "alt+left",        "command": "workbench.action.navigateBack" },
{ "key": "alt+right",       "command": "workbench.action.navigateForward" },

// Global keyboard shortcuts using chords (two separate keypress actions)
{ "key": "ctrl+k enter",    "command": "workbench.action.keepEditor" },
{ "key": "ctrl+k ctrl+w",   "command": "workbench.action.closeAllEditors" },

可接受的按键

key 由修饰符和按键本身组成。

接受以下修饰符

接受以下按键

• f1-f19, a-z, 0-9
• `, -, =, [, ], \, ;, ', ,, ., /
• left, up, right, down, pageup, pagedown, end, home
• tab, enter, escape, space, backspace, delete
• pausebreak, capslock, insert
• numpad0-numpad9, numpad_multiply, numpad_add, numpad_separator
• numpad_subtract, numpad_decimal, numpad_divide

命令参数

你可以使用参数调用命令。如果你经常对特定文件或文件夹执行相同的操作，这会很有用。你可以添加自定义键盘快捷键来精确地执行你想要的操作。

以下是覆盖 Enter 键以打印一些文本的示例

{
  "key": "enter",
  "command": "type",
  "args": { "text": "Hello World" },
  "when": "editorTextFocus"
}

type 命令将接收 {"text": "Hello World"} 作为其第一个参数，并向文件中添加“Hello World”，而不是生成默认命令。

有关接受参数的命令的更多信息，请参阅内置命令。

运行多个命令

可以使用命令 runCommands 配置键盘快捷键以按顺序运行多个命令。

• 运行不带参数的多个命令

  以下示例将当前行向下复制，将当前行标记为注释，并将光标移动到复制的行。

  {
    "key": "ctrl+alt+c",
    "command": "runCommands",
    "args": {
      "commands": [
        "editor.action.copyLinesDownAction",
        "cursorUp",
        "editor.action.addCommentLine",
        "cursorDown"
      ]
    }
  },
  

• 要将参数传递给命令

  此示例创建一个新的无标题 TypeScript 文件并插入一个自定义片段。

  {
    "key": "ctrl+n",
    "command": "runCommands",
    "args": {
      "commands": [
        {
          "command": "workbench.action.files.newUntitledFile",
          "args": {
            "languageId": "typescript"
          }
        },
        {
          "command": "editor.action.insertSnippet",
          "args": {
            "langId": "typescript",
            "snippet": "class ${1:ClassName} {\n\tconstructor() {\n\t\t$0\n\t}\n}"
          }
        }
      ]
    }
  },
  

请注意，由 runCommands 运行的命令会接收 "args" 的值作为第一个参数。在前面的示例中，workbench.action.files.newUntitledFile 接收 {"languageId": "typescript" } 作为其第一个也是唯一的参数。

要传递多个参数，你需要将 "args" 设置为数组

{
  "key": "ctrl+shift+e",
  "command": "runCommands",
  "args": {
    "commands": [
      {
        // command invoked with 2 arguments: vscode.executeCommand("myCommand", "arg1", "arg2")
        "command": "myCommand",
        "args": ["arg1", "arg2"]
      }
    ]
  }
}

要将数组作为第一个参数传递，请将数组包装在另一个数组中："args": [ [1, 2, 3] ]。

删除键盘快捷键

要删除键盘快捷键，请右键单击“键盘快捷键”编辑器中的条目，然后选择 删除按键绑定。

要使用 keybindings.json 文件删除键盘快捷键，请在 command 前面添加 -，该规则将成为删除规则。

这里有一个例子

// In Default Keyboard Shortcuts
...
{ "key": "tab", "command": "tab", "when": ... },
{ "key": "tab", "command": "jumpToNextSnippetPlaceholder", "when": ... },
{ "key": "tab", "command": "acceptSelectedSuggestion", "when": ... },
...

// To remove the second rule, for example, add in keybindings.json:
{ "key": "tab", "command": "-jumpToNextSnippetPlaceholder" }

要使用空操作覆盖特定键盘快捷键规则，你可以指定一个空命令

// To override and disable any `tab` keyboard shortcut, for example, add in keybindings.json:
{ "key": "tab", "command": "" }

键盘布局

按键是虚拟按键的字符串表示形式，不一定与按下时生成的字符相关。更准确地说

• 参考：虚拟按键代码 (Windows)
• tab 代表 VK_TAB (0x09)
• ; 代表 VK_OEM_1 (0xBA)
• = 代表 VK_OEM_PLUS (0xBB)
• , 代表 VK_OEM_COMMA (0xBC)
• - 代表 VK_OEM_MINUS (0xBD)
• . 代表 VK_OEM_PERIOD (0xBE)
• / 代表 VK_OEM_2 (0xBF)
• ` 代表 VK_OEM_3 (0xC0)
• [ 代表 VK_OEM_4 (0xDB)
• \ 代表 VK_OEM_5 (0xDC)
• ] 代表 VK_OEM_6 (0xDD)
• ' 代表 VK_OEM_7 (0xDE)
• 等等

不同的键盘布局通常会重新定位这些虚拟按键，或者更改按下时生成的字符。当使用非标准 US 键盘布局时，Visual Studio Code 会执行以下操作

所有键盘快捷键都使用当前系统的键盘布局呈现在 UI 中。例如，当使用法语（法国）键盘布局时，Split Editor 现在呈现为 Ctrl+*

在编辑 keybindings.json 时，VS Code 会突出显示误导性的键盘快捷键，这些快捷键在文件中以标准 US 键盘布局下生成的字符表示，但在当前系统键盘布局下需要按具有不同标签的按键。例如，这是使用法语（法国）键盘布局时默认键盘快捷键规则的样子

还有一个 UI 控件可以帮助在编辑 keybindings.json 时输入键盘快捷键规则。要启动 定义按键绑定 控件，请按 ⌘K ⌘K (Windows、Linux Ctrl+K Ctrl+K)。该控件会监听按键并将其序列化的 JSON 表示呈现在文本框中，并在其下方显示 VS Code 在你当前键盘布局下检测到的按键。一旦你键入了你想要的按键组合，你可以按 Enter 键，然后会插入一个规则片段。

与键盘布局无关的绑定

使用扫描代码，可以定义不随键盘布局更改而更改的键盘快捷键。例如

{ "key": "cmd+[Slash]", "command": "editor.action.commentLine", "when": "editorTextFocus" }

接受的扫描代码

• [F1]-[F19], [KeyA]-[KeyZ], [Digit0]-[Digit9]
• [Backquote], [Minus], [Equal], [BracketLeft], [BracketRight], [Backslash], [Semicolon], [Quote], [Comma], [Period], [Slash]
• [ArrowLeft], [ArrowUp], [ArrowRight], [ArrowDown], [PageUp], [PageDown], [End], [Home]
• [Tab], [Enter], [Escape], [Space], [Backspace], [Delete]
• [Pause], [CapsLock], [Insert]
• [Numpad0]-[Numpad9], [NumpadMultiply], [NumpadAdd], [NumpadComma]
• [NumpadSubtract], [NumpadDecimal], [NumpadDivide]

when 子句上下文

VS Code 通过可选的 when 子句为你提供了对何时启用键盘快捷键的精确控制。如果你的键盘快捷键没有 when 子句，则该键盘快捷键始终全局可用。when 子句评估为 true 或 false，以启用键盘快捷键。

VS Code 根据 VS Code UI 中哪些元素可见和活动设置各种上下文键和特定值。例如，内置的 开始调试 命令的键盘快捷键为 F5，仅当有合适的调试器可用（上下文 debuggersAvailable 为 true）且编辑器不在调试模式（上下文 inDebugMode 为 false）时才启用

你也可以在默认的 keybinding.json 中直接查看键盘快捷键的 when 子句（首选项：打开默认键盘快捷键 (JSON)）

{ "key": "f5",  "command": "workbench.action.debug.start",
                   "when": "debuggersAvailable && !inDebugMode" },

条件运算符

对于 when 子句条件表达式，以下条件运算符对键盘快捷键很有用

你可以在 when 子句上下文 参考中找到完整的 when 子句条件运算符列表。

可用上下文

你可以在 when 子句上下文参考 中找到一些可用的 when 子句上下文。

那里的列表并不详尽，你可以通过在“键盘快捷键”编辑器中搜索和筛选（首选项：打开键盘快捷键）或查看默认 keybindings.json 文件（首选项：打开默认键盘快捷键 (JSON)）来找到其他 when 子句上下文。

重构的自定义键盘快捷键

editor.action.codeAction 命令允许你为特定的重构（代码操作）配置键盘快捷键。例如，下面的键盘快捷键触发 提取函数 重构代码操作

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function"
  }
}

这在重构文章中有深入介绍，你可以在其中了解不同类型的代码操作以及在存在多个可能的重构时如何确定它们的优先级。

相关资源

• VS Code 默认键盘快捷键参考

常见问题

如何找出特定按键绑定到哪个命令？

在“键盘快捷键”编辑器中，你可以筛选特定按键以查看哪些命令绑定到哪些按键。在下面的屏幕截图中，你可以看到 Ctrl+Shift+P 绑定到 显示所有命令 以调出命令面板。

如何为某个操作添加键盘快捷键，例如，为“删除行”添加 Ctrl+D

在 默认键盘快捷键 中找到触发该操作的规则，并在你的 keybindings.json 文件中编写一个修改后的版本

// Original, in Default Keyboard Shortcuts
{ "key": "ctrl+shift+k",          "command": "editor.action.deleteLines",
                                     "when": "editorTextFocus" },
// Modified, in User/keybindings.json, Ctrl+D now will also trigger this action
{ "key": "ctrl+d",                "command": "editor.action.deleteLines",
                                     "when": "editorTextFocus" },

如何仅为某些文件类型添加键盘快捷键？

在你的 when 子句中使用 editorLangId 上下文键

{ "key": "shift+alt+a",           "command": "editor.action.blockComment",
                                     "when": "editorTextFocus && editorLangId == csharp" },

我在 keybindings.json 中修改了键盘快捷键；为什么它们不起作用？

最常见的问题是文件中的语法错误。否则，请尝试删除 when 子句或选择不同的 key。不幸的是，在这一点上，这是一个反复试验的过程。