利⽤clang-format格式化代码
最近⼯作需要⽤到代码格式化功能,决定利⽤clang-format来格式化代码。
第⼀步:安装clang-format
直接安装LLVM
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: false
# 声明时,对齐所有声明的变量名
AlignConsecutiveDeclarations: true
# 右对齐逃脱换⾏(使⽤反斜杠换⾏)的反斜杠
AlignEscapedNewlines: Right
# ⽔平对齐⼆元和三元表达式的操作数
AlignOperands: true
# 对齐连续的尾随的注释
AlignTrailingComments: true
# 不允许函数声明的所有参数在放在下⼀⾏
AllowAllParametersOfDeclarationOnNextLine: false
# 不允许短的块放在同⼀⾏
AllowShortBlocksOnASingleLine: true
# 允许短的case标签放在同⼀⾏
AllowShortCaseLabelsOnASingleLine: true
# 允许短的函数放在同⼀⾏: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中,空函数), All
AllowShortFunctionsOnASingleLine: None
# 允许短的if语句保持在同⼀⾏
AllowShortIfStatementsOnASingleLine: true
# 允许短的循环保持在同⼀⾏
AllowShortLoopsOnASingleLine: true
# 总是在返回类型后换⾏: None, All, TopLevel(顶级函数,不包括在类中的函数),
# AllDefinitions(所有的定义,不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType: None
# 总是在多⾏string字⾯量前换⾏
AlwaysBreakBeforeMultilineStrings: false
# 总是在template声明后换⾏
AlwaysBreakTemplateDeclarations: true
# false表⽰函数实参要么都在同⼀⾏,要么都各⾃⼀⾏
BinPackArguments: true
# false表⽰所有形参要么都在同⼀⾏,要么都各⾃⼀⾏
BinPackParameters: true
BinPackParameters: true
# ⼤括号换⾏,只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
# class定义后⾯
AfterClass: false
# 控制语句后⾯
AfterControlStatement: false
# enum定义后⾯
AfterEnum: false
# 函数定义后⾯
AfterFunction: false
# 命名空间定义后⾯
AfterNamespace: false
# struct定义后⾯
AfterStruct: false
# union定义后⾯
AfterUnion: false
# extern之后
AfterExternBlock: false
# catch之前
BeforeCatch: false
# else之前
BeforeElse: false
# 缩进⼤括号
IndentBraces: false
# 分离空函数
SplitEmptyFunction: false
# 分离空语句
SplitEmptyRecord: false
# 分离空命名空间
SplitEmptyNamespace: false
# 在⼆元运算符前换⾏: None(在操作符后换⾏), NonAssignment(在⾮赋值的操作符前换⾏), All(在操作符前换⾏) BreakBeforeBinaryOperators: NonAssignment
# 在⼤括号前换⾏: Attach(始终将⼤括号附加到周围的上下⽂), Linux(除函数、命名空间和类定义,与Attach类似),
# Mozilla(除枚举、函数、记录定义,与Attach类似), Stroustrup(除函数定义、catch、else,与Attach类似),
# Allman(总是在⼤括号前换⾏), GNU(总是在⼤括号前换⾏,并对于控制语句的⼤括号增加额外的缩进), WebKit(在函数前换⾏), Custom # 注:这⾥认为语句块也属于函数
BreakBeforeBraces: Custom
# 在三元运算符前换⾏
BreakBeforeTernaryOperators: false
# 在构造函数的初始化列表的冒号后换⾏
BreakConstructorInitializers: AfterColon
#BreakInheritanceList: AfterColon
BreakStringLiterals: false
# 每⾏字符的限制,0表⽰没有限制
ColumnLimit: 0
CompactNamespaces: true
# 构造函数的初始化列表要么都在同⼀⾏,要么都各⾃⼀⾏
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth: 4
# 延续的⾏的缩进宽度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的⼤括号{后和}前的空格
Cpp11BracedListStyle: true
# 继承最常⽤的指针和引⽤的对齐⽅式
DerivePointerAlignment: false
# 固定命名空间注释
FixNamespaceComments: true
FixNamespaceComments: true
# 缩进case标签
格式化命令format参数IndentCaseLabels: false
IndentPPDirectives: None
# 缩进宽度
IndentWidth: 4
# 函数返回类型换⾏时,缩进函数声明或函数定义的函数名IndentWrappedFunctionNames: false
# 保留在块开始处的空⾏
KeepEmptyLinesAtTheStartOfBlocks: false
# 连续空⾏的最⼤数量
MaxEmptyLinesToKeep: 1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All NamespaceIndentation: None
# 指针和引⽤的对齐: Left, Right, Middle
PointerAlignment: Left
# 允许重新排版注释
ReflowComments: true
# 允许排序#include
SortIncludes: false
# 允许排序 using 声明
SortUsingDeclarations: false
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast: false
# 在Template 关键字后⾯添加空格
SpaceAfterTemplateKeyword: true
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# SpaceBeforeCpp11BracedList: true
# SpaceBeforeCtorInitializerColon: true
# SpaceBeforeInheritanceColon: true
# 开圆括号之前添加⼀个空格: Never, ControlStatements, Always SpaceBeforeParens: ControlStatements
# SpaceBeforeRangeBasedForLoopColon: true
# 在空的圆括号中添加空格
SpaceInEmptyParentheses: false
# 在尾随的评论前添加的空格数(只适⽤于//) SpacesBeforeTrailingComments: 1
# 在尖括号的<;后和>前添加空格
SpacesInAngles: false
# 在C风格类型转换的括号中添加空格SpacesInCStyleCastParentheses: false
# 在容器(ObjC和JavaScript的数组和字典等)字⾯量中添加空格SpacesInContainerLiterals: true
# 在圆括号的(后和)前添加空格
SpacesInParentheses: false
# 在⽅括号的[后和]前添加空格,lamda表达式和未指明⼤⼩的数组的声明不受影响
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论