代码格式化工具:clang-format

IDE: Visual Studio Code

Language: C/C++

格式化工具: clang-format

安装

vscode安装扩展C/C++，扩展程序将自动安装clang-format:

配置首选项

• 打开首选项

  快捷键: Command + ,

• 搜索 clang-format进行配置

• 配置生效快捷键

  • 当前文件全文格式化

    Shift + option + F

  • 选择块格式化

    Command + K

    Command + F

配置格式化主题

配置项 C_Cpp: Clang_format_fallback Style

• 可选主题
  • Visual Studio
  • LLVM
  • Google
  • Chromium
  • Mozilla
  • WebKit
  • none
  • {key: value, …}
• 自定义key-value写法参考

{ BasedOnStyle: Google, IndentWidth: 4, IndentCaseLabels: false, AccessModifierOffset: -4, AlignTrailingComments: true }

• 常用配置项

# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language: Cpp

# 基于某一主题上的修改
BasedOnStyle: Google

# 缩进宽度
IndentWidth: 4

# 缩进case标签
IndentCaseLabels: false

# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4

# 每行字符的限制，0表示没有限制
ColumnLimit: 80

# 对齐连续的尾随的注释
AlignTrailingComments: true

# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine: false
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine: false
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine: true
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine: false

# 允许排序#include
SortIncludes: true

更多配置项参考:

• VS Code C++ 代码格式化方法(clang-format)
• Clang-Format Style Options

配置格式化形式

配置项 C_Cpp: Clang_format_style

默认是 file, 将会调用在当前工程下的 .clang-format 文件

注: 该种格式化配置, 优先级比上条配置方式高!

主题文件可通过clang-format工具生成, 例

# 若未安装则执行
brew install clang-format

# 生成主题文件
clang-format -style=Google -dump-config > .clang-format

配置文件保存时自动格式化

按 Command + S 保存文件时, 或关闭当前文件的编辑, 将会触发自动格式化代码

配置行末加 ; 时自动格式化

类似 Xcode, 一条语句后加分号, 将会自动触发自动格式化代码

---

最后附上我使用的 代码格式化样式：

{ BasedOnStyle: Google, IndentWidth: 4 }