Clang-format 配置文件

齊家治國平天下
已于 2023-08-10 16:53:53 修改
阅读量8.5k
点赞数 4
分类专栏： C/C++开发 Android 软件开发文章标签： clang-format c/c++ 配置文件自定义代码规范
于 2019-09-16 10:04:10 首次发布
原文链接：https://releases.llvm.org/14.0.0/tools/clang/docs/ClangFormatStyleOptions.html
版权
Android 软件开发同时被 2 个专栏收录
25 篇文章
订阅专栏
C/C++开发
8 篇文章
订阅专栏
前言

因配置文件与别人重合度太高，发不了原创，特改为转载
官方文档

最新官方详细配置解释点击此处
clang-format-14的配置官方详解
文件格式

.clang-format
配置文件放置规则

不指定,默认从需要格式化的文件同级目录向上寻找.clang-format文件
--stype指定配置文件或者默认配置
参考配置文件(基于clang-format-14)

#基于那个配置文件
BasedOnStyle: Google
Language: Cpp
ColumnLimit: 120
BraceWrapping:
 # case标签后面
 AfterCaseLabel:  false
 # class定义后面
 AfterClass: false
 # 控制语句后面
 AfterControlStatement: Never
 # enum定义后面
 AfterEnum:       false
 # 函数定义后面
 AfterFunction:   false
 # 命名空间定义后面
 AfterNamespace:  false
 # ObjC定义后面
 AfterObjCDeclaration: false
 # struct定义后面
 AfterStruct:     false
 # union定义后面
 AfterUnion:      false
 #ExternBlock定义后面
 AfterExternBlock: false
 # catch之前
 BeforeCatch:     false
 # else之前
 BeforeElse:      false
 # lambda块之前
 BeforeLambdaBody: false
 # while之前
 BeforeWhile:     false
 # 缩进大括号
 IndentBraces:    false
 # 分割空函数
 SplitEmptyFunction: true
 # 分割空记录
 SplitEmptyRecord: true
 # 分割空命名空间
 SplitEmptyNamespace: true

# 在 @property 后面添加空格, \@property (readonly) 而不是 \@property(readonly).
ObjCSpaceAfterProperty: true
# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4

# 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
AlignAfterOpenBracket: Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments: None
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations: false
# 连续宏声明时，对齐空格 #clang-format-10 可用
AlignConsecutiveMacros: true
# 对齐连接符: DontAlign(不对齐)， Left(左对齐), Right(右对齐)
AlignEscapedNewlines: Left
# 水平对齐二元和三元表达式的操作数
AlignOperands: Align
# 对齐连续的尾随的注释
AlignTrailingComments: true
# 允许函数调用的所有参数在放在下一行
AllowAllArgumentsOnNextLine: true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine: true
# 允许短的块放在同一行
AllowShortBlocksOnASingleLine: Never
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine: false
# 允许短的枚举放在同一行
AllowShortEnumsOnASingleLine: false
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine: None
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine: Never
# 允许短的Lambdas语句保持在同一行
AllowShortLambdasOnASingleLine: None
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine: false
# 总是在定义返回类型后换行(deprecated)
AlwaysBreakAfterDefinitionReturnType: None
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数),
#   AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType: None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings: false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations: Yes
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments: true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters: true
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators: NonAssignment
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似),
#   Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注：这里认为语句块也属于函数
BreakBeforeBraces: Custom
# 在三元运算符前换行
BreakBeforeTernaryOperators: true
# 在构造函数的初始化列表的逗号前换行
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
# 在类声明继承列表的逗号前换行
BreakInheritanceList: BeforeColon
BreakAfterJavaFieldAnnotations: false
# 允许中断长字符串
BreakStringLiterals: true
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
CommentPragmas: '^ IWYU pragma:'
# 允许连续的名称空间声明将在同一行
CompactNamespaces: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth: 4
# 延续的行的缩进宽度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的大括号{后和}前的空格
Cpp11BracedListStyle: true
# 继承最常用的指针和引用的对齐方式
DerivePointerAlignment: true
# 关闭格式化
DisableFormat:   false
# 修饰符后放置空行
EmptyLineAfterAccessModifier: Never
# 修饰符前放置空行
EmptyLineBeforeAccessModifier: LogicalBlock
# 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)
ExperimentalAutoDetectBinPacking: false
# 修正命名空间注释
FixNamespaceComments: true
# 需要被解读为foreach循环而不是函数调用的宏
ForEachMacros:
 - foreach
 - Q_FOREACH
 - BOOST_FOREACH
# 需要解读为if的函数
IfMacros:
 - KJ_IF_MAYBE
IncludeBlocks:   Regroup
# 对#include进行排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越小排序越靠前)，
#   可以定义负数优先级从而保证某些#include永远在最前面
IncludeCategories:
 - Regex:           '^<ext/.*\.h>'
   Priority:        2
   SortPriority:    0
   CaseSensitive:   false
 - Regex:           '^<.*\.h>'
   Priority:        1
   SortPriority:    0
   CaseSensitive:   false
 - Regex:           '^<.*'
   Priority:        2
   SortPriority:    0
   CaseSensitive:   false
 - Regex:           '.*'
   Priority:        3
   SortPriority:    0
   CaseSensitive:   false    
# include块排序
IncludeIsMainRegex: '([-_](test|unittest))?$'
# 缩进修饰符
IndentAccessModifiers: false
# 缩进case块
IndentCaseBlocks: false
# 缩进case标签
IndentCaseLabels: true
# 缩进goto标签
IndentGotoLabels: true
# 预处理缩进
IndentPPDirectives: None
# 缩进extern块
IndentExternBlock: AfterExternBlock
# 缩进模板中的require子句。
IndentRequires:  false
# 缩进宽度
IndentWidth: 4
# 函数返回类型换行时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames: false
# 添加尾部注释
InsertTrailingCommas: None
# 保留在块开始处的空行
KeepEmptyLinesAtTheStartOfBlocks: true
# Lambda块缩进
LambdaBodyIndentation: Signature
# 开始一个块的宏的正则表达式
MacroBlockBegin: ''
# 结束一个块的宏的正则表达式
MacroBlockEnd: ''
# 连续空行的最大数量
MaxEmptyLinesToKeep: 1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation: None
# 使用ObjC块时缩进宽度
ObjCBlockIndentWidth: 4
# 在ObjC的protocol列表前添加一个空格
ObjCSpaceBeforeProtocolList: false
# 使用的包构造函数初始化式样式
PackConstructorInitializers: NextLine
# 在call(后对函数调用换行的penalty
PenaltyBreakBeforeFirstCallParameter: 19
# 在一个注释中引入换行的penalty
PenaltyBreakComment: 300
# 第一次在<<前换行的penalty
PenaltyBreakFirstLessLess: 120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString: 1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine: 200
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment: Left
PPIndentWidth:   -1
RawStringFormats:
 - Language:        Cpp
   Delimiters:
     - cc
     - CC
     - cpp
     - Cpp
     - CPP
     - 'c++'
     - 'C++'
   CanonicalDelimiter: ''
   BasedOnStyle:    google
 - Language:        TextProto
   Delimiters:
     - pb
     - PB
     - proto
     - PROTO
   EnclosingFunctions:
     - EqualsProto
     - EquivToProto
     - PARSE_PARTIAL_TEXT_PROTO
     - PARSE_TEST_PROTO
     - PARSE_TEXT_PROTO
     - ParseTextOrDie
     - ParseTextProtoOrDie
     - ParseTestProto
     - ParsePartialTestProto
   CanonicalDelimiter: pb
   BasedOnStyle:    google
# 引用对齐    
ReferenceAlignment: Pointer
# 允许重新排版注释
ReflowComments: true
# 允许排序#include
SortIncludes:    CaseSensitive
# 允许排序声明
SortUsingDeclarations: true
# 单独的定义块
SeparateDefinitionBlocks: Always
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast: false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 在逻辑非操作符之后插入一个空格
SpaceAfterLogicalNot: false
# 在' template '关键字之后会插入一个空格
SpaceAfterTemplateKeyword: true
# 在用于初始化对象的c++ 11带括号的列表之前(在前面的标识符或类型之后)将插入一个空格
SpaceBeforeCpp11BracedList: false
# 构造函数初始化式冒号前的空格将被删除
SpaceBeforeCtorInitializerColon: true
# 在继承冒号前添加空格
SpaceBeforeInheritanceColon: true
# 控制括号前的单独空格。
SpaceBeforeParens: ControlStatements
# 开圆括号之前添加一个空格
SpaceBeforeParensOptions:
 AfterControlStatements: true
 AfterForeachMacros: true
 AfterFunctionDefinitionName: false
 AfterFunctionDeclarationName: false
 AfterIfMacros:   true
 AfterOverloadedOperator: false
 BeforeNonEmptyParentheses: false
# 在空的圆括号中添加空格
SpaceInEmptyParentheses: false
# 在基于冒号的范围循环之前 添加空格
SpaceBeforeRangeBasedForLoopColon: true
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments: 2
# 在尖括号的<后和>前添加空格
SpacesInAngles:  Never
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals: true
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses: false
# 在圆括号的(后和)前添加空格
SpacesInParentheses: false
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets: false
# 标准: Cpp03, Cpp11, Auto
Standard: c++14
# tab宽度
TabWidth: 4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
DeriveLineEnding: false
UseCRLF: false
WhitespaceSensitiveMacros:
 - STRINGIZE
 - PP_STRINGIZE
 - BOOST_PP_STRINGIZE
 - NS_SWIFT_NAME
 - CF_SWIFT_NAME