.clang-format

最新推荐文章于 2025-10-28 09:51:37 发布
原创 最新推荐文章于 2025-10-28 09:51:37 发布 · 1.6k 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文详细介绍ClangFormat代码格式化工具的配置选项，涵盖多种编程语言，如C++、Java、JavaScript等，旨在帮助开发者统一代码风格，提高代码可读性和维护性。

-i $(ItemPath) 外部工具参数

# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language:	Cpp
# BasedOnStyle:	LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset:	-3
# 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
AlignAfterOpenBracket:	Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments:	true
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations:	true
# 左对齐逃脱换行(使用反斜杠换行)的反斜杠
AlignEscapedNewlinesLeft:	true
# 水平对齐二元和三元表达式的操作数
AlignOperands:	true
# 对齐连续的尾随的注释
AlignTrailingComments:	true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine:	true
# 允许短的块放在同一行
AllowShortBlocksOnASingleLine:	true
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine:	true
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine:	Empty
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine:	true
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine:	true
# 总是在定义返回类型后换行(deprecated)
AlwaysBreakAfterDefinitionReturnType:	None
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数), 
#   AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType:	None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings:	false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations:	true
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments:	true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters:	true
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:   
  # class定义后面
  AfterClass:	true
  # 控制语句后面
  AfterControlStatement:	true
  # enum定义后面
  AfterEnum:	true
  # 函数定义后面
  AfterFunction:	true
  # 命名空间定义后面
  AfterNamespace:	true
  # ObjC定义后面
  AfterObjCDeclaration:	true
  # struct定义后面
  AfterStruct:	true
  # union定义后面
  AfterUnion:	true
  # 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:	0
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
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:	false
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals:	true
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses:	true
# 在圆括号的(后和)前添加空格
SpacesInParentheses:	false
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets:	false
# 标准: Cpp03, Cpp11, Auto
Standard:	Cpp11
# tab宽度
TabWidth:	4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab:	Always
Clang-Format格式化选项介绍
子丰的博客
10-26 10万+
Clang-Format可用于格式化（排版）多种不同语言的代码，其自带的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit。        如果你使用Visual Studio Code编写代码（本人当前用来编写C++），VSCode的C/C++插件自带了Clang-Format格式化工具，不仅拥有上述5种排版格式，还定义了自己的Visual Stud
精选资源
linux 系统clang-format可执行文件，vscode clang-format插件
11-16
Linux系统中的Clang-Format是一个强大的源代码格式化工具，主要应用于C++、C、Objective-C、Objective-C++以及CUDA等编程语言。它遵循特定的编码风格，可以帮助开发者保持代码的一致性和整洁性，这对于团队协作和...
【代码格式化参数配置说明】clang format 官方文档自定义参数介绍（中文）
isanth
08-11 4567
官方文档：http://clang.llvm.org/docs/ClangFormatStyleOptions.html 在代码中配置样式 当使用 clang::format::reformat(...) 方法, 格式将被clang::format::FormatStyle 框架指定。 配置格式化样式选项 这一部分列出了被支持的选项。 每个操作都有指定类型。 枚举类型的可能的值，被C++枚举（一个预编译，例如：LS_Auto）和配置中的一个值（没有预编译：Auto）指定。 BasedOnSt
VS Code C++ 代码格式化方法(clang-format)
热门推荐
core571的博客
09-27 14万+
前提条件 安装扩展C/C++，扩展程序将自动安装clang-format。clang-format默认安装路径为c:\Users\wqr57\.vscode\extensions\ms-vscode.cpptools-0.18.1/bin/../LLVM/bin/clang-format.exe   首选项设置 打开首选项设置（ctrl + ,），搜索format . 可勾选form...
Clang-Format 统一代码风格（详解）
最新发布
m0_37383484的博客
10-28 1195
VS Code/Cursor 中配置 Clang-Format 实现代码格式化 本文介绍了在 VS Code 或 Cursor 中配置和使用 Clang-Format 工具的完整流程： 安装 C/C++ 扩展 安装 Clang 工具链（Windows/macOS/Linux 不同方法） 配置 .clang-format 文件定义代码风格 设置 VS Code 使用 Clang-Format（包括自动保存时格式化） 提供常用配置示例和 settings.json 模板 通过这套配置，开发者可以实现代码风格的自
vscode设置C++代码格式化（Clang-Format）
吴尼玛cs
03-06 1万+
vscode中只要安装了C/C++扩展后，在C/C++源文件中右键就能看到格式化文档的选项，这样就能通过该选项或者其快捷键（Shift+Alt+F）来实现快速格式化代码。本文主要介绍如何自定义格式化。
[转载] Sublime Text 3 插件 ClangFormat 格式化 C/C++版
u013946150的博客
02-03 877
参考链接： 在Clang工具的帮助下创建C/C++代码格式化工具 Sublime Text 3 ClangFormat格式化 C/C++版 插件安装 ctrl+shift+p找到Package Control: Install Package 搜索ClangFormat，等待安装即可 编译配置 Tool -> Build System -> New Build System 保存文件名：myc++.build { "path": "C:/MinGW/bin", ...
clang-format 提取自 官网的 LLVM-16.0.6-win64.exe
08-18
exe自带了几种代码格式化风格。 如果使用默认风格，则简单方便。 如果要自定义风格，似乎在 LLVM-16.0.6-win64....Qt Creator 使用 clang-format格式化代码 https://blog.csdn.net/ken2232/article/details/131891507
VSCode C/C++ Clang自定义样式文件.clang-format
09-10
VSCode C/C++ Clang自定义样式文件.clang-format。 基于Google样式，根据自己的习惯修改。 见博文：https://blog.csdn.net/hxiaohai/article/details/100705224
vs code 代码格式化
小白菜的博客
08-13 426
设置vs code代码在一行显示 设置 -》 首选项 -》 setting -》 setting.json里放入下面代码 { “vetur.format.defaultFormatter.js”: “vscode-typescript”, “vetur.format.defaultFormatterOptions”: { “js-beautify-html”: { “wrap_attributes”: “force-expand-multiline”, “wap_line_length”: 22
vs code代码格式化
我不是程序员的博客
12-14 749
vscode 代码格式化 这种长长的代码格式看着很难受 看到这种就很舒服了 怎么改呢？ 在vs code 按住快捷键Ctrl+shift+P搜索setting.json，加入以下代码块即可 { "vetur.format.options.tabSize": 2, "vetur.format.options.useTabs": false, "vetur.format.defaultFormatter.html": "js-beautify-html", "vetur.for
windows 下 vs code 格式化代码（clang-format）
qq_38781075的博客
09-29 7968
可以直接把这个 exe 解压，里面有个 bin 目录，bin 目录有个 clang-format.exe （就要这个文件）2、windows 下载 LLVM-17.0.1-win64.exe （exe 结尾的安装包）格式化所有代码：shift + alt + f 或者右键代码空白处，有个格式化代码选项。5、格式化的个性化设置可以通过指定 .clang-format 文件来配置。格式化部分代码：选中部分代码，ctrl + k , ctrl + f。3、配置 clang-format.exe 路径。
vs code代码格式化配置
IT菜鸟
11-04 5831
vs code代码格式化配置
在 Visual Studio Code 中配置 Clang-Format 格式化 (排版) 工具
程永强
11-17 4796
在 Visual Studio Code (VS Code) 中配置 Clang-Format 格式化 (排版) 工具
VSCODE 系列（七）格式化工具clang-format
qq_26849933的博客
01-28 8179
clang-format
vscode 统一规范代码格式问题
qq_44759522的博客
08-03 3025
3、除了第2步这种方式，还可以给项目根目录创建一个.prettierrc配置文件，同时创建.prettierignore文件，由于prettier插件优先使用项目根目录下的.prettierrc配置文件对代码进行格式化，而忽略settings.json的配置。格式化文件（VS Code格式化按键），如下图，每个缩进4空格。1、EditorConfig for VS Code 插件。.prettierignore 配置忽略如下。# 忽略dist目录下文件的语法检查。.prettierrc配置如下。
我遇到的VS code代码格式化对齐及编码格式问题和解决方法
weixin_46061455的博客
04-20 5120
该文章仅仅是我使用VScode遇到的一些问题与解决方法的记录
vs code 代码保存自动格式化
minmin_web的博客
03-14 2293
vs code安装插件Prettier - Code formatter 配置settings.json文件 按照路径：file->preferences->settings，输入eslint配置json文件 文件粘贴代码，根据自己需要可在文件中增加或修改 { // vscode默认启用了根据文件类型自动设置tabsize的选项 "editor.detectIndentation": false, // 重新设定tabsize "editor.tabSize": 2, /
如何使用.clang-format
08-19
`.clang-format` 是一个用于格式化 C、C++、Java、JavaScript、Objective-C 等代码的配置文件，由 `clang-format` 工具读取并根据配置规则自动格式化代码。 --- ## ✅ 一、基本使用步骤 ### 1. 安装 clang-format 确保你已经安装了 `clang-format`，以下是不同系统的安装方式： - **Ubuntu/Debian**： ```bash sudo apt install clang-format ``` - **macOS (Homebrew)**： ```bash brew install clang-format ``` - **Windows (使用 vcpkg)**： ```powershell vcpkg install clang-format ``` 或者安装 [LLVM 官方包](https://releases.llvm.org/) --- ### 2. 创建 `.clang-format` 文件 你可以手动创建 `.clang-format` 文件放在项目的根目录中，或使用命令生成一个默认配置： ```bash clang-format -style=LLVM -dump-config > .clang-format ``` 你也可以使用其他风格，如： ```bash clang-format -style=Google -dump-config > .clang-format clang-format -style=Chromium -dump-config > .clang-format clang-format -style=Mozilla -dump-config > .clang-format clang-format -style=WebKit -dump-config > .clang-format ``` --- ### 3. 示例 `.clang-format` 文件（Google 风格） ```yaml BasedOnStyle: Google IndentWidth: 4 TabWidth: 4 UseTab: Never ColumnLimit: 100 BraceWrapping: AfterControlStatement: Always AfterEnum: false AfterFunction: false AfterStruct: false AfterUnion: false BeforeElse: true SpaceBeforeAssignmentOperators: true PointerAlignment: Right ``` --- ## ✅ 二、在命令行中使用 `.clang-format` ### 1. 格式化单个文件并输出到终端 ```bash clang-format your_file.cpp ``` ### 2. 直接修改文件内容（in-place） ```bash clang-format -i your_file.cpp ``` ### 3. 格式化整个目录中的所有 `.cpp` 和 `.h` 文件 ```bash find . -name "*.cpp" -o -name "*.h" | xargs clang-format -i ``` --- ## ✅ 三、在 VSCode 中使用 `.clang-format` ### 1. 安装插件 推荐使用插件：`xaver.clang-format` ### 2. 设置 VSCode 使用 `.clang-format` 在 `settings.json` 中添加以下配置： ```json { "[c]": { "editor.defaultFormatter": "xaver.clang-format" }, "[cpp]": { "editor.defaultFormatter": "xaver.clang-format" }, "editor.formatOnSave": true } ``` 这样保存文件时会自动格式化。 --- ## ✅ 四、常用配置选项说明 | 配置项 | 含义 | |--------|------| | `BasedOnStyle` | 基于的预设风格（如 Google、LLVM） | | `IndentWidth` | 缩进宽度 | | `UseTab` | 是否使用 Tab（Never, ForIndentation, ForContinuationAndIndentation） | | `ColumnLimit` | 每行最大字符数 | | `BraceWrapping.AfterFunction` | 函数大括号是否换行 | | `PointerAlignment` | 指针符号对齐方式（Left, Middle, Right） | | `AllowShortIfStatementsOnASingleLine` | 是否允许单行 if 语句 | | `SpaceBeforeAssignmentOperators` | 赋值操作符前是否加空格 | --- ## ✅ 五、在 Git 中使用 clang-format（可选） 你可以设置 Git 的 pre-commit 钩子，在提交前自动格式化代码： ```bash #!/bin/sh # # An example hook script to verify what is about to be committed. # Called by "git commit" with no arguments. The hook should # exit with non-zero status after issuing an appropriate message if # it wants to stop the commit. exec git diff --cached --name-only | grep -E '\.(c|cpp|h|hpp)$' | xargs clang-format -i ``` 将上面内容保存为 `.git/hooks/pre-commit`，并赋予执行权限： ```bash chmod +x .git/hooks/pre-commit ``` --- ## ✅ 六、总结 | 操作 | 命令/方式 | |------|-----------| | 创建 `.clang-format` | `clang-format -style=Google -dump-config > .clang-format` | | 格式化单个文件 | `clang-format your_file.cpp` | | 修改文件内容 | `clang-format -i your_file.cpp` | | VSCode 中使用 | 安装插件 + 设置默认格式化器 | | Git 提交前自动格式化 | 使用 `pre-commit` 钩子 | ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值