https://www.cnblogs.com/tudou/p/13322854.html
代码格式化
YAML:1:4: error: Got empty plain scalar
.clang-format文件的编码格式必须是UTF-8，否则会出现YAML:1:4: error: Got empty plain scalar错误

必须将“.clang-format”文件放在要格式化的文件父文件夹下，clang-format会从要格式的文件目录开始，向上搜索，直到搜索到.clang-format，可以放在工程的根目录下，

--style=<string>           - Coding style, currently supports:LLVM, Google, Chromium, Mozilla, WebKit.Use -style=file to load style configuration from.clang-format file located in one of the parentdirectories of the source file (or currentdirectory for stdin).Use -style="{key: value, ...}" to set specificparameters, e.g.:-style="{BasedOnStyle: llvm, IndentWidth: 8}"

目录
参考信息

介绍
安装
命令格式
基本使用
使用.clang-format来实现自定义格式化
导出.clang-format文件
使用.clang-format文件
.clang-format配置文件的各个选项的含义
集成到vim中(官方给出了各种IDE或编辑器集成方式)
常用命令
clang-format-diff.py脚本
参考信息
官方参考：https://clang.llvm.org/docs/ClangFormat.html
入门博客参考：https://blog.csdn.net/softimite_zifeng/article/details/78357898
介绍
OVERVIEW: A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code.

Clang-Format可用于格式化（排版）多种不同语言的代码。
其自带的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit等

若-style=google ，则表示应用Google的格式化风格

安装
请看官网上的安装方式，或者Google一下你的OS安装方式吧。

这里给出我常用OS安装方式：
macOS10.14.6 brew install clang-format
ubuntu18.04 sudo apt install clang-format

命令格式
USAGE: clang-format [options] [ …]

clang-format --help 建议至少浏览一遍帮助信息。

基本使用
// 以LLVM代码风格格式化main.cpp, 结果输出到stdout
clang-format -style=LLVM main.cpp
// 以LLVM代码风格格式化main.cpp, 结果直接写到main.cpp
clang-format -style=LLVM -i main.cpp
// 当然也支持对指定行格式化，格式化main.cpp的第1，2行
clang-format -lines=1:2 main.cpp
使用.clang-format来实现自定义格式化
导出.clang-format文件
When the desired code formatting style is different from the available options, the style can be customized using the -style="{key: value, …}" option or by putting your style configuration in the .clang-format or _clang-format file in your project’s directory and using clang-format -style=file.

An easy way to create the .clang-format file is:

clang-format -style=可选格式名 -dump-config > .clang-format

可选格式最好写预设那那几个写最接近你想要的格式. 比如我想要接近google C++ style的。我就写-style=google

看了官网的介绍，我们知道我们可以使用.clang-format 文件来自定义格式。在使用时不再是-style=llvm等内置可选的那几种的格式。
使用我们自定义.clang-formart文件来格式化。指定方式为-style=file

注意：一般取.clang-format或_clang-format，因为自定义的排版格式文件只有取这两种名字之一，才能被Clang-Format识别。

现在对生成的.clang-format文件根据自己需求进行修改吧

使用.clang-format文件
直接将修改后的文件放在和代码文件相同的文件夹中，并且设置格式化选项-style=file，即可以使用自定义的排版格式。
VS Code只要将该文件放在和代码文件相同的文件夹中即可，不需要额外的设置。
格式化文件放在代码文件的上一级文件夹中，也可以使用。(个人建议放在项目的根目录下。我看不少开源项目就是这么干的，嘿嘿嘿)
注意，文件名必须为.clang-format或_clang-format。

# 格式化的结果打到stdout(终端上)
clang-format -style=file main.cc
# 直接修改到文件
clang-format -style=file -i main.cc
.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
# 允许短的循环保持在同一行
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
...
注意： 一般不全部重定义规则, 提供了BasedOnStyle标识让我们来重定义部分格式---
# We'll use defaults from the LLVM style, but with 4 columns indentation.
BasedOnStyle: LLVM
IndentWidth: 4
---
Language: Cpp
# Force pointers to the type for C++.
DerivePointerAlignment: false
PointerAlignment: Left
---
Language: JavaScript
# Use 100 columns for JS.
ColumnLimit: 100
---
Language: Proto
# Don't format .proto files.
DisableFormat: true
---
Language: CSharp
# Use 100 columns for C#.
ColumnLimit: 100
...

集成到vim中(官方给出了各种IDE或编辑器集成方式)
详细看官方网站

常用命令
格式化C++项目的代码

find . -regex ‘.*.(cpp|hpp|cu|c|h)’ -exec clang-format -style=file -i {} ;
clang-format-diff.py脚本
clang-format还提供一个clang-format-diff.py脚本，用来格式化patch，code review提交代码前，
可以先跑一下这个脚本，看有没有问题。

// 格式化最新的commit，并直接在原文件上修改
git diff -U0 HEAD^ | clang-format-diff.py -i -p1
官网写了 git svn Mercurial/hg 的使用，详细请到官网看吧

clang-format相关推荐

clang format 官方文档自定义参数介绍（中英文）
官方文档:http://clang.llvm.org/docs/ClangFormatStyleOptions.html 中文在代码中配置样式当使用 clang::format::reformat( ...
clang format
clang format入门一:VsCode下载二:ubuntu下载三:使用(common) 导出 .clang-format 格式化文件自己找了一些资料,感觉不是太完整,零零碎碎自己来总结一 ...
【Qt】QtCreator中配置clang-format
1.安装clang-format sudo apt install clang-format 2.添加插件Beautifier 在QtCreator–>Help–>About Plugin ...
Qt Creator指定代码样式设置
Qt Creator指定代码样式设置指定代码样式设置指定代码样式设置 Qt Creator使用文件的MIME类型来确定用于打开文件的模式和编辑器.Qt Creator在C ++代码编辑器中以&qu ...
vscode 配置代码格式化工具calng-format，windows/linux都支持
1.安装clang-format工具 linux (ubuntu) sudo apt-get install clang-format-11 windows 下载clang-format.exe,并将 ...
VSCode工具 - C/C++
记录一下开发中比较符合自己使用习惯的工具,以免之后再次出现花费长时间查找的问题 C/C++ 简介 The C/C++ extension adds language support for C/C++ ...
Clang-Format-Options 中文翻译
My C/C++ Code Style settings based on Google 作者: tiandyoin 翻译日期: 2022.9.1 翻译版本: clang-format 14.0.6 ...
编译器GCC与Clang的异同
GCC:GNU(Gnu's Not Unix)编译器套装(GNU Compiler Collection,GCC),指一套编程语言编译器,以GPL及LGPL许可证所发行的自由软件,也是GNU项目的关键 ...
深入剖析 iOS 编译 Clang LLVM(编译流程)
2019独角兽企业重金招聘Python工程师标准>>> 前言 iOS 开发中 Objective-C 和 Swift 都用的是 Clang / LLVM 来编译的.LLVM是一个模块 ...
ARM 之七主流编译器（armcc、iar、gcc for arm、LLVM(clang)）详细介绍
必备在讲解各编译器之前,必须先了解一下以下这些文件.这些文件在编译器目录下或者编译生成目标平台的可执行程序时经常见到.此外,还需要注意区分 Windows 平台和 Linux 平台的文件. . ...

clang-format

可选格式最好写预设那那几个写最接近你想要的格式. 比如我想要接近google C++ style的。我就写-style=google

clang-format相关推荐

最新文章

热门文章

clang-format

可选格式最好写预设那那几个写最接近你想要的格式. 比如我想要接近google C++ style的。 我就写-style=google

clang-format相关推荐

最新文章

热门文章

可选格式最好写预设那那几个写最接近你想要的格式. 比如我想要接近google C++ style的。我就写-style=google