clang-format使用

1. clang-format简介
2. clang-format的使用
- 2.1 clang-format中.clang-format file
- 2.2 示例：配置google的代码风格
- 2.3 vscode clang-format配置
3. clang-format 中 .clang-format file配置（yaml格式）
- 3.1 配置多个语言的约束
- 3.2 将某段代码忽略format
- 3.3 对齐方式
- 3.4 数组的左右对其设置
- 3.5 连续赋值语句的格式设置，是否等号对齐
- 3.6 AlignConsecutiveBitFields
- 3.7 AlignConsecutiveDeclarations
- 3.8 宏的对齐AlignConsecutiveMacros
- 3.9 AlignEscapedNewlines（对齐选项中的反斜杠转义换行符）
- 3.10 对齐操作符
- 3.11 尾部注释格式
- 3.12 函数调用
- 3.13 函数对齐
参考文献

1. clang-format简介

Clang-Format可用于格式化（排版）多种不同语言的代码。
其自带的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit等; 利用style参数配置风格。
通过编写 .clang-format 文件，可以实现代码风格的配置。

2. clang-format的使用

2.1 clang-format中.clang-format file

我们可以自定制代码风格约束，通过一下命令进行使用：

clang-format -sytle=file

注意：file不是 .clang-format file的路径，就是file关键字；说明使用 the .clang-format file located in the closest parent directory of the input file. clang-format的设置进行代码约束；其他选项：-style=LLVM, Google, Chromium, Mozilla, WebKit

而.clang-format file由一下命令生成：生成google风格的clang-format配置文件

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

第二种方法配置：也可以通过设置key:value的方式进行
如：

clang-format -style="{BasedOnStyle: llvm, IndentWidth:8} ..."

2.2 示例：配置google的代码风格

#1) 生成.clang-format文件
clang-format -style=google -dump-config > .clang-format
# 2) 配置.clang-format: 参考：https://clang.llvm.org/docs/ClangFormatStyleOptions.html
# 3）通过.clang-format文件，进行代码风格约束
# 格式化结果打印到中断
clang-format -style=file code.cpp
# 直接修改文件
clang-format -style=file -i code.cpp

2.3 vscode clang-format配置

3. clang-format 中 .clang-format file配置（yaml格式）

3.1 配置多个语言的约束

---
# We'll use defaults from the LLVM style, but with 4 columns indentation.
BasedOnStyle: LLVM
IndentWidth: 4
---
# C++
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
...

3.2 将某段代码忽略format

int formatted_code;
// clang-format offvoid    unformatted_code  ;
// clang-format on
void formatted_code_again;

3.3 对齐方式

3.4 数组的左右对其设置

实际None设置为false;
注意：clang-format的版本，只有13是支持的
13版本前不支持

3.5 连续赋值语句的格式设置，是否等号对齐

根据下面的示例可以清楚的设置不同的格式情况；
注意：clang-format的版本，只有13是支持的
13版本前只支持true/false

3.6 AlignConsecutiveBitFields

3.7 AlignConsecutiveDeclarations

与AlignConsecutiveAssignments一样配置；将声明语句与赋值语句对齐

3.8 宏的对齐AlignConsecutiveMacros

3.9 AlignEscapedNewlines（对齐选项中的反斜杠转义换行符）

3.10 对齐操作符

3.11 尾部注释格式

3.12 函数调用

3.13 函数对齐

根据需要设定不同的配置：
具体说明：https://clang.llvm.org/docs/ClangFormatStyleOptions.html

参考文献

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

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的使用