在 Visual Studio Code 中自动格式化 C# 代码

Question

我在我的 Visual Studio Code 编辑器中启用了最新的 C# 扩展。而不是在保存时格式化代码或通过应用组合键 Ctrl + K、Ctrl + F 或 Alt + Shift + F，我需要在按下 Enter 键的同时格式化当前代码行。此功能已在 Visual Studio 中可用，但默认情况下在 Visual Studio Code 中没有。

这是我需要实现的示例代码输出：

Answer 1

转到菜单文件 → 首选项 → 设置。

搜索格式

选择您想要的选项：

• 粘贴时格式化

• 保存时格式化

• 类型格式

关闭设置窗口。

你也可以在你的 settings.json 文件中看到它：

Answer 2

我找到了一个选项，可以在键入时更轻松地格式化代码。

我在工作区设置中应用了以下设置：

{
      "editor.formatOnSave": true,
      "editor.formatOnType": true
}

这对我来说很好。

Answer 3

Visual Studio 上可用的代码格式化程序默认为

• 在 Windows 上：Shift + Alt + F
• 在 Mac 上：Shift + Option + F

如果您希望在按 Enter 时再次执行此操作，则需要设置工作区首选项，然后配置键绑定：

{ "key": "enter", "command": "editor.action.format" }

如果没有选择任何内容，它现在会格式化整个文档，否则它会格式化选择。

还有 beautify.onSave、editor.formatOnSave 选项。请也尝试这样做以使代码更漂亮。

Answer 4

编辑：这实际上不起作用，因为这将抑制常规 Enter 键行为

要让它为我工作我必须安装两个扩展程序

• C# (powered by OmniSharp)
• C# FixFormat

如果没有第二个扩展，我收到了错误visual studio code there is no formatter for 'csharp'-files installed

我还确保我的 Visual Studio Code 是最新的（菜单* → 帮助 → 重启和更新或检查更新）

然后我添加了一个自定义键绑定。菜单 File → Preferences → Keyboard Shortcuts → “对于高级自定义打开和编辑 keybindings.json”： p>

[{
    "key": "enter",
    "command": "editor.action.formatDocument",
    "when": "editorTextFocus"
}
]

我必须输入单词enter，因为捕获密钥的对话框不承认它。

Answer 5

转到菜单文件 → 首选项 → 键盘快捷键 (Ctrl + K, Ctrl + S)

点击keybindings.json链接：

为 Enter 键输入以下绑定。此绑定将覆盖当前用户的默认设置。

{
  "key": "enter",
  "command": "editor.action.formatDocument",
  "when": "editorHasSelection"
}

另一种替代解决方案是使用 macros extension - Visual Studio Code 的自定义宏支持，因此您可以在一个键绑定中执行多个命令。

给User Settings添加宏：

"macros": {
    "formatWithEnter": [
        "editor.action.insertLineAfter",
        "editor.action.formatDocument"
    ]
}

以下键绑定到keybindings.json：

{
    "key": "enter",
    "command": "macros.formatWithEnter"
}