使用clang-format工具格式化代码风格

clang-format是一个代码格式化工具,支持多种预设风格如LLVM、Chromium等,也可自定义风格配置。用户可以通过.style文件或命令行参数指定风格,用法包括`clang-format-style=llvmfile.cpp`。此外,可以使用`-dump-config`生成默认配置,并基于此创建自己的风格配置文件。该工具有助于保持代码一致性。
摘要由CSDN通过智能技术生成

使用clang-format工具格式化代码风格

setup

sudo apt-get install clang-format

usage

clang-format -style=llvm -i demo.cpp

style可以是LLVMChromiumMozillaWebKitMicrosoftGNU等;
也可以是file,此时clang-format使用当前目录或父目录下的.clang-format_clang-format文件作为风格配置。

self definition style

可以自定义风格配置文件并命名为.clang-format_clang-format放到当前目录或父目录,然后通过-style=file来使用;

clang-format -style=file -i demo.cpp

如果想查看默认配置,可以dump出来,

clang-format -style=llvm -dump-config > .clang-format

可以根据这个配置进行自定义,形成自己的风格。

配置示例

_clang-format

---
# https://clang.llvm.org/docs/ClangFormatStyleOptions.html

BasedOnStyle: google
Language:        Cpp

# this style configuration is based on google style configuration.
# The following configuration is different from the basic configuration.

# 缩进宽度
IndentWidth:     4

# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4

# # 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
# AlignAfterOpenBracket: Align

# # 连续赋值时,对齐所有等号
# AlignConsecutiveAssignments: false

# # 连续声明时,对齐所有声明的变量名
# AlignConsecutiveDeclarations: false

# # 右对齐逃脱换行(使用反斜杠换行)的反斜杠
# AlignEscapedNewlines: Right

# # 水平对齐二元和三元表达式的操作数
# AlignOperands: true

# # 对齐连续的尾随的注释
# AlignTrailingComments: true

# # 函数声明的所有参数在放在下一行
# AllowAllParametersOfDeclarationOnNextLine: false

# # 短的块放在同一行
# AllowShortBlocksOnASingleLine: false

# # 短的case标签放在同一行
# AllowShortCaseLabelsOnASingleLine: true

# # 短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中,空函数), All
# AllowShortFunctionsOnASingleLine: None

# # 短的if语句保持在同一行
# AllowShortIfStatementsOnASingleLine: true

# # 短的循环保持在同一行
# AllowShortLoopsOnASingleLine: true

# # 总是在返回类型后换行: None, All, TopLevel(顶级函数,不包括在类中的函数), 
# # AllDefinitions(所有的定义,不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
# AlwaysBreakAfterReturnType: None

# # 总是在多行string字面量前换行
# AlwaysBreakBeforeMultilineStrings: true

# # 总是在template声明后换行
# AlwaysBreakTemplateDeclarations: true

# # false表示函数实参要么都在同一行,要么都各自一行
# BinPackArguments: true

# # false表示所有形参要么都在同一行,要么都各自一行
# BinPackParameters: true

# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义,与Attach类似), 
#   Mozilla(除枚举、函数、记录定义,与Attach类似), Stroustrup(除函数定义、catch、else,与Attach类似), 
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行,并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注:这里认为语句块也属于函数
BreakBeforeBraces: Custom

# 大括号换行,只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
  # class定义后面
  AfterClass: true
  # 控制语句后面
  AfterControlStatement: false
  # enum定义后面
  AfterEnum: true
  # 函数定义后面
  AfterFunction: true
  # 命名空间定义后面
  AfterNamespace: true
  # struct定义后面
  AfterStruct: true
  # union定义后面
  AfterUnion: true
  # extern之后
  AfterExternBlock: true
  # catch之前
  BeforeCatch: false
  # else之前
  BeforeElse: false
  # 缩进大括号
  IndentBraces: false
  # 分离空函数
  SplitEmptyFunction: true
  # 分离空语句
  SplitEmptyRecord: true
  # 分离空命名空间
  SplitEmptyNamespace: true

# # 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
# BreakBeforeBinaryOperators: NonAssignment

# BreakBeforeInheritanceComma: false

# # 在三元运算符前换行
# BreakBeforeTernaryOperators: false

# BreakConstructorInitializersBeforeComma: false

# # 在构造函数的初始化列表的冒号后换行 AfterColon, 前 BeforeColon
BreakConstructorInitializers: BeforeColon

# BreakAfterJavaFieldAnnotations: false

# BreakStringLiterals: false

# # 每行字符的限制,0表示没有限制
ColumnLimit:     00

# CommentPragmas:  '^ IWYU pragma:'
# CompactNamespaces: false

# # 构造函数的初始化列表要么都在同一行,要么都各自一行
# ConstructorInitializerAllOnOneLineOrOnePerLine: false

# # 构造函数的初始化列表的缩进宽度
# ConstructorInitializerIndentWidth: 4

# # 延续的行的缩进宽度
# ContinuationIndentWidth: 4

# # 去除C++11的列表初始化的大括号{后和}前的空格
# Cpp11BracedListStyle: true

# # 继承最常用的指针和引用的对齐方式
# DerivePointerAlignment: true

# DisableFormat:   false
# ExperimentalAutoDetectBinPacking: false

# # 固定命名空间注释
# FixNamespaceComments: true

# ForEachMacros:   
#   - foreach
#   - Q_FOREACH
#   - BOOST_FOREACH
# IncludeBlocks:   Preserve
# IncludeCategories: 
#   - Regex:           '^<ext/.*\.h>'
#     Priority:        2
#   - Regex:           '^<.*\.h>'
#     Priority:        1
#   - Regex:           '^<.*'
#     Priority:        2
#   - Regex:           '.*'
#     Priority:        3
# IncludeIsMainRegex: '([-_](test|unittest))?$'

# # 缩进case标签
# IndentCaseLabels: false

# IndentPPDirectives: None

# # 函数返回类型换行时,缩进函数声明或函数定义的函数名
# IndentWrappedFunctionNames: false

# JavaScriptQuotes: Leave
# JavaScriptWrapImports: true

# # 保留在块开始处的空行
# KeepEmptyLinesAtTheStartOfBlocks: false
# MacroBlockBegin: ''
# MacroBlockEnd:   ''

# # 连续空行的最大数量
# MaxEmptyLinesToKeep: 1

# # 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
# NamespaceIndentation: None

# ObjCBlockIndentWidth: 2
# ObjCSpaceAfterProperty: false
# ObjCSpaceBeforeProtocolList: false
# PenaltyBreakAssignment: 2
# PenaltyBreakBeforeFirstCallParameter: 1
# PenaltyBreakComment: 300
# PenaltyBreakFirstLessLess: 120
# PenaltyBreakString: 1000
# PenaltyExcessCharacter: 1000000
# PenaltyReturnTypeOnItsOwnLine: 200

# # 指针和引用的对齐: Left, Right, Middle
# PointerAlignment: Left

# RawStringFormats: 
#   - Delimiter:       pb
#     Language:        TextProto
#     BasedOnStyle:    google

# # 重新排版注释
ReflowComments:  false

# # 重新排序#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

# # 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
# SpacesInContainerLiterals: true

# # 在C风格类型转换的括号中添加空格
# SpacesInCStyleCastParentheses: false

# # 在圆括号的(后和)前添加空格
# SpacesInParentheses: false

# # 在方括号的[后和]前添加空格,lamda表达式和未指明大小的数组的声明不受影响
# SpacesInSquareBrackets: false

# # 标准: Cpp03, Cpp11, Auto
# Standard: Cpp11

# # tab宽度
TabWidth: 4

# # 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
---
Clang-Format提供了多种代码风格选项,可以根据具体需求选择合适的风格。常见的一些代码风格选项包括: 1. Google风格:这是谷歌公司使用代码风格,它强调代码的可读性和一致性。它使用4个空格缩进,函数名称使用小写字母和下划线,类名使用大写字母开头等。 2. Chromium风格:这是谷歌Chrome团队使用代码风格,它在Google风格的基础上做了一些自定义修改。 3. LLVM风格:这是LLVM项目使用代码风格,它强调代码的可读性、简洁性和一致性。它使用2个空格缩进,函数名称使用小写字母和下划线,类名使用大写字母开头等。 4. Mozilla风格:这是Mozilla项目使用代码风格,它强调代码的可读性、简洁性和一致性。它使用2个空格缩进,函数名称使用小写字母和下划线,类名使用大写字母开头等。 5. WebKit风格:这是WebKit项目使用代码风格,它强调代码的可读性和一致性。它使用2个空格缩进,函数名称使用小写字母和下划线,类名使用大写字母开头等。 此外,Clang-Format还支持自定义风格,可以通过编写.clang-format文件来定义自己的代码风格。 总结来说,Clang-Format提供了多种代码风格选项,包括Google、Chromium、LLVM、Mozilla和WebKit等,同时也支持自定义风格。具体选择哪种风格取决于个人或团队的需求和偏好。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [VS2019使用clang-format实现源代码格式化排版,解决“No Target Architecture”问题](https://blog.csdn.net/libaineu2004/article/details/112760035)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [.clang-format](https://download.csdn.net/download/misslong/11615479)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值