.clang-format 常见配置
时间: 2025-03-09 11:07:58 浏览: 23
clang-format 文件常见配置项
Clang-format 是一种强大的工具,用于自动格式化 C/C++/Java/Objective-C 等编程语言的源代码。通过 .clang-format
文件可以自定义代码风格设置。常见的配置项及其功能描述如下:
1. 基本样式参数
- 基于现有风格
BasedOnStyle
: 定义基础风格,可选值有 LLVM、Google、Chromium、Mozilla 和 Microsoft。- 使用命令如
clang-format -style=llvm -dump-config > .clang-format
可以创建基于特定风格的基础配置文件[^1]。
- 使用命令如
2. 缩进控制
缩进宽度
IndentWidth
: 设置每一级缩进所使用的空格数,默认为 2 或者遵循选定的基本风格设定。
连续声明对齐
AlignConsecutiveDeclarations
: 控制是否使连续变量声明左对齐。
宏定义对齐
- 对于某些版本可能不支持像
AlignConsecutiveMacros
的选项,在遇到此类情况时应考虑更新 Clang 版本来获得最新特性支持[^3]。
- 对于某些版本可能不支持像
3. 行宽与换行策略
最大行长度
ColumnLimit
: 设定每行的最大字符数量限制;当超过此限值时会尝试折行处理。
短语拆分方式
BinPackParameters
: 影响函数调用中的参数列表如何被包裹成多行。- 当设为
true
时倾向于保持紧凑布局; - 若为
false
则更偏好让每个实参独占一行。
- 当设为
4. 大括号放置规则
类体大括号位置
AccessModifierOffset
: 调整访问修饰符(public, private, protected)相对于类名的偏移量。
其他结构的大括号
BreakBeforeBraces
: 指明在哪些情况下应该把开括号放在新行上而不是紧跟其前的内容之后。 - 支持多种模式如 Allman、GNU、Stroustrup 等不同编码习惯下的大括号摆放方案。
以下是部分常用配置项的一个简单例子:
---
Language: Cpp
# Based on the Google style guide.
BasedOnStyle: Google
IndentWidth: 4
ContinuationIndentWidth: 4
UseTab: Never
ColumnLimit: 80
AccessModifierOffset: -4
AllowShortIfStatementsOnASingleLine: false
AlwaysBreakTemplateDeclarations: true
...
相关推荐
















