简介 #
代码格式混乱、不一致，不仅降低可读性，还会让代码审查变得更困难，并可能增加出错的风险。
幸运的是，你无需手动对齐括号或修复缩进 —— clang-format 可以根据统一的规则自动格式化代码，甚至可以匹配团队的代码风格指南。
本文将介绍：
- 什么是
clang-format以及为什么要用它 - 如何安装
- 如何运行
- 如何自定义格式化规则
- 如何将它集成到工作流程中
什么是 clang-format？ #
clang-format 是一个命令行工具，能自动格式化 C、C++、Objective-C、Java、JavaScript、TypeScript、Protobuf 等语言的源代码。它会根据预定义或自定义的风格规则调整缩进、空格和代码布局。
优点：
- 让代码整洁一致
- 减少代码审查中的格式相关评论
- 节省手动调整格式的时间
- 支持多语言和多编辑器
第一步 – 安装 clang-format #
在 Ubuntu/Debian #
sudo apt update
sudo apt install clang-format
在 macOS（Homebrew） #
brew install clang-format
在 Windows #
可以通过以下方式安装：
- LLVM 官方安装包
- 或使用
choco：
choco install llvm
第二步 – 基本用法 #
直接在文件中格式化：
clang-format -i myfile.cpp
不加 -i 会将结果输出到终端：
clang-format myfile.cpp
第三步 – 选择风格 #
clang-format 内置多种风格：
LLVM（默认）GoogleMozillaWebKitMicrosoftGNU
示例：
clang-format -i -style=Google myfile.cpp
第四步 – 创建 .clang-format 配置文件 #
为了保证项目统一，可以在项目根目录创建 .clang-format 文件：
BasedOnStyle: Google
IndentWidth: 4
ColumnLimit: 100
也可以从某个风格生成基础配置：
clang-format -style=Google -dump-config > .clang-format
然后按需修改。
第五步 – 格式化多个文件 #
一次性格式化所有 .cpp 和 .h 文件：
find . -regex '.*\.(cpp\|h)' -exec clang-format -i {} \;
第六步 – 编辑器集成 #
VS Code
- 安装 Clang-Format 插件
- 在
settings.json中设置：
"C_Cpp.clang_format_fallbackStyle": "Google"
Vim
autocmd BufWritePre *.cpp,*.h execute ':silent! !clang-format -i %'
CLion / Visual Studio
- 内置支持，在设置中启用即可。
第七步 – 集成到 CI/CD #
在 CI 中强制检查格式：
clang-format --dry-run --Werror **/*.cpp
如果格式不正确，构建会失败。
示例（前后对比） #
格式化前：
int main(){int x= 1; if(x>0){std::cout<<"Hello";}}
格式化后（Google 风格）：
int main() {
int x = 1;
if (x > 0) {
std::cout << "Hello";
}
}
总结 #
使用 clang-format 可以让代码保持整洁统一，不必手动调整缩进和空格。无论是个人开发者还是团队协作，将它融入日常开发流程，都能显著提升代码可读性和协作效率。