Clang-Format格式化选项介绍
Clang-Format可⽤于格式化（排版）多种不同语⾔的代码，其⾃带的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit。
如果你使⽤Visual Studio Code编写代码（⼦丰当前⽤来编写C++），VSCode的C/C++插件⾃带了Clang-Format 格式化⼯具，不仅拥有上述5种排版格式，还定义了⾃⼰的Visual Studio排版格式，且此格式是默认的排版格式（Ubuntu 下格式化快捷键：Ctrl+Shift+I，Windows下格式化快捷键：Shift+Alt+F），VS Code格式化的具体内容可以参考官⽹：
但是⾃带的这⼏种排版格式可能并不满⾜个⼈编码习惯的全部要求，Clang-Format也提供了使⽤⾃定义排版格式的功能。
如果在Ubuntu中安装了Clang-Format，则可以使⽤以下命令导出上述5种⾃带的排版格式，并且可以对其中某⼀个导出的⽂件进⾏修改，实现⾃定义格式化：
clang-format -style=格式名 -dump-config > ⽂件名格式化命令format参数
其中，格式名的取值可以为llvm, google, chromium, mozilla, webkit中的任⼀种；⽂件名可以取任何名字，⼀般取.clang-format或_clang-format，因为⾃定义的排版格式⽂件只有取这两种名字之⼀，才能被
Clang-Format识别。在Ubuntu下以点开头命名的⽂件是隐藏⽂件，所以导出为.clang-format后，在⽂件夹中看不到该⽂件，可以使⽤快捷键
Ctrl+h显⽰隐藏⽂件。
直接将修改后的⽂件放在和代码⽂件相同的⽂件夹中，并且设置格式化选项-style=file，即可以使⽤⾃定义的排版格式。VS Code只要将该⽂件放在和代码⽂件相同的⽂件夹中即可，不需要额外的设置。⼦丰将格式化⽂件放在代码⽂件的上⼀级⽂件夹中，也可以使⽤。注意，⽂件名必须为.clang-format或_clang-format。
下⾯主要介绍⼀下Clang-Format中每个选项的含义，这⾥直接贴出⼦丰修改后的.clang-format⽂件，每个选项在其上⽅都有对应的中⽂说明。如果觉得说明不够详细，可以查看Clang-Format的官⽹的⽂档，并且该⽂档中针对每个选项都会有例⼦代码，所以浅显易懂：
注：可能下⾯贴出的内容在个别选项上与官⽹⽂档不⼀样，这是由于Clang-Format的版本不⼀样的。
---
# 语⾔: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language: Cpp
# BasedOnStyle: LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4
# 开括号(开圆括号、开尖括号、开⽅括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换⾏)
AlignAfterOpenBracket: Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments: true
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations: true
# 左对齐逃脱换⾏(使⽤反斜杠换⾏)的反斜杠
AlignEscapedNewlinesLeft: true
# ⽔平对齐⼆元和三元表达式的操作数
AlignOperands: true
# 对齐连续的尾随的注释
AlignTrailingComments: true
# 允许函数声明的所有参数在放在下⼀⾏
AllowAllParametersOfDeclarationOnNextLine: true
# 允许短的块放在同⼀⾏
AllowShortBlocksOnASingleLine: false
# 允许短的case标签放在同⼀⾏
AllowShortCaseLabelsOnASingleLine: false
# 允许短的函数放在同⼀⾏: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All AllowShortFunctionsOnASingleLine: Empty
# 允许短的if语句保持在同⼀⾏
AllowShortIfStatementsOnASingleLine: false
AllowShortIfStatementsOnASingleLine: false
# 允许短的循环保持在同⼀⾏
AllowShortLoopsOnASingleLine: false
# 总是在定义返回类型后换⾏(deprecated)
AlwaysBreakAfterDefinitionReturnType: None
# 总是在返回类型后换⾏: None, All, TopLevel(顶级函数，不包括在类中的函数),
#  AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType: None
# 总是在多⾏string字⾯量前换⾏
AlwaysBreakBeforeMultilineStrings: false
# 总是在template声明后换⾏
AlwaysBreakTemplateDeclarations: false
# false表⽰函数实参要么都在同⼀⾏，要么都各⾃⼀⾏
BinPackArguments: true
# false表⽰所有形参要么都在同⼀⾏，要么都各⾃⼀⾏
BinPackParameters: true
# ⼤括号换⾏，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
# class定义后⾯
AfterClass: false
# 控制语句后⾯
AfterControlStatement: false
# enum定义后⾯
AfterEnum: false
# 函数定义后⾯
AfterFunction: false
# 命名空间定义后⾯
AfterNamespace: false
# ObjC定义后⾯
AfterObjCDeclaration: false
# struct定义后⾯
AfterStruct: false
# union定义后⾯
AfterUnion: false
# catch之前
BeforeCatch: true
# else之前
BeforeElse: true
# 缩进⼤括号
IndentBraces: false
# 在⼆元运算符前换⾏: None(在操作符后换⾏), NonAssignment(在⾮赋值的操作符前换⾏), All(在操作符前换⾏) BreakBeforeBinaryOperators: NonAssignment
# 在⼤括号前换⾏: Attach(始终将⼤括号附加到周围的上下⽂), Linux(除函数、命名空间和类定义，与Attach类似),
#  Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),
#  Allman(总是在⼤括号前换⾏), GNU(总是在⼤括号前换⾏，并对于控制语句的⼤括号增加额外的缩进), WebKit(在函数前换⾏), Custom #  注：这⾥认为语句块也属于函数
BreakBeforeBraces: Custom
# 在三元运算符前换⾏
BreakBeforeTernaryOperators: true
# 在构造函数的初始化列表的逗号前换⾏
BreakConstructorInitializersBeforeComma: false
# 每⾏字符的限制，0表⽰没有限制
ColumnLimit: 200
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多⾏或以其它⽅式改变
CommentPragmas: '^ IWYU pragma:'
# 构造函数的初始化列表要么都在同⼀⾏，要么都各⾃⼀⾏
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth: 4
# 延续的⾏的缩进宽度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的⼤括号{后和}前的空格
Cpp11BracedListStyle: false
# 继承最常⽤的指针和引⽤的对齐⽅式
DerivePointerAlignment: false
# 关闭格式化
# 关闭格式化
DisableFormat: false
# ⾃动检测函数的调⽤和定义是否被格式为每⾏⼀个参数(Experimental)
ExperimentalAutoDetectBinPacking: false
# 需要被解读为foreach循环⽽不是函数调⽤的宏
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
# 对#include进⾏排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越⼩排序越靠前)，#  可以定义负数优先级从⽽保证某些#include永远在最前⾯
IncludeCategories:
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
Priority: 2
- Regex: '^(<|"(gtest|isl|json)/)'
Priority: 3
- Regex: '.*'
Priority: 1
# 缩进case标签
IndentCaseLabels: false
# 缩进宽度
IndentWidth: 4
# 函数返回类型换⾏时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames: false
# 保留在块开始处的空⾏
KeepEmptyLinesAtTheStartOfBlocks: true
# 开始⼀个块的宏的正则表达式
MacroBlockBegin: ''
# 结束⼀个块的宏的正则表达式
MacroBlockEnd: ''
# 连续空⾏的最⼤数量
MaxEmptyLinesToKeep: 1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation: Inner
# 使⽤ObjC块时缩进宽度
ObjCBlockIndentWidth: 4
# 在ObjC的@property后添加⼀个空格
ObjCSpaceAfterProperty: false
# 在ObjC的protocol列表前添加⼀个空格
ObjCSpaceBeforeProtocolList: true
# 在call(后对函数调⽤换⾏的penalty
PenaltyBreakBeforeFirstCallParameter: 19
# 在⼀个注释中引⼊换⾏的penalty
PenaltyBreakComment: 300
# 第⼀次在<<；前换⾏的penalty
PenaltyBreakFirstLessLess: 120
# 在⼀个字符串字⾯量中引⼊换⾏的penalty
PenaltyBreakString: 1000
# 对于每个在⾏字符数限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 将函数的返回类型放到它⾃⼰的⾏的penalty
PenaltyReturnTypeOnItsOwnLine: 60
# 指针和引⽤的对齐: Left, Right, Middle
PointerAlignment: Left
# 允许重新排版注释
ReflowComments: true
# 允许排序#include
SortIncludes: true
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast: false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 开圆括号之前添加⼀个空格: Never, ControlStatements, Always
SpaceBeforeParens: ControlStatements
# 在空的圆括号中添加空格
SpaceInEmptyParentheses: false
# 在尾随的评论前添加的空格数(只适⽤于//)
SpacesBeforeTrailingComments: 2
# 在尖括号的<；后和>前添加空格
# 在尖括号的<；后和>前添加空格
SpacesInAngles: true
# 在容器(ObjC和JavaScript的数组和字典等)字⾯量中添加空格SpacesInContainerLiterals: true
# 在C风格类型转换的括号中添加空格SpacesInCStyleCastParentheses: true
# 在圆括号的(后和)前添加空格
SpacesInParentheses: true
# 在⽅括号的[后和]前添加空格，lamda表达式和未指明⼤⼩的数组的声明不受影响SpacesInSquareBrackets: true
# 标准: Cpp03, Cpp11, Auto
Standard: Cpp11
# tab宽度
TabWidth: 4
# 使⽤tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always UseTab: Never
...

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。