VSCode C/C++ 格式化配置【最完整准确版本】
创始人
2025-06-01 08:10:35

一、下载Clang-format

1、在VSCode插件商店下载 C/C++插件 和 Clang-format 插件


步骤二、步骤三为多余踩坑过程,可跳过。

二、生成 .clang-format 文件

2、去到: C:\Users\<你的用户名>.vscode\extensions\ms-vscode.cpptools-1.14.4-win32-x64\LLVM\bin\

3、打开终端,cd到此处,执行以下代码:
.\clang-format.exe -style="llvm" -dump-config > .clang-format

4、然后就会得到一个 .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
# 宏对齐
AlignConsecutiveMacros: 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:	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# extern AfterExternBlock: false# case后换行AfterCaseLabel: true
# 在二元运算符前换行: 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 #126
# 描述具有特殊意义的注释的正则表达式,它不应该被分割为多行或以其它方式改变
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:	true
# 缩进宽度
IndentWidth:	4
# 函数返回类型换行时,缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames:	false
# 保留在块开始处的空行
KeepEmptyLinesAtTheStartOfBlocks:	true
# 开始一个块的宏的正则表达式
MacroBlockBegin:	''
# 结束一个块的宏的正则表达式
MacroBlockEnd:	''
# 连续空行的最大数量
MaxEmptyLinesToKeep:	10
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation:	Inner
# 使用ObjC块时缩进宽度
ObjCBlockIndentWidth:	4
# 在ObjC的@property后添加一个空格
ObjCSpaceAfterProperty:	false
# 在ObjC的protocol列表前添加一个空格
ObjCSpaceBeforeProtocolList:	true
# 在call(后对函数调用换行的penalty
PenaltyBreakBeforeFirstCallParameter:	19
# 在一个注释中引入换行的penalty
PenaltyBreakComment:	106
# 第一次在<<前换行的penalty
PenaltyBreakFirstLessLess:	120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString:	1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter:	1000000
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:	60
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment:	Right
# 允许重新排版注释
ReflowComments:	true
# 允许排序#include
SortIncludes:	false
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast:	false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators:	true
# 开圆括号之前添加一个空格: Never, ControlStatements, Always
SpaceBeforeParens:	Never #ControlStatements
# 在空的圆括号中添加空格
SpaceInEmptyParentheses:	false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments:	4
# 在尖括号的<后和>前添加空格
SpacesInAngles:	true
# 在容器(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:	Always

三、VS Code设置

5、使用 ctrl + , 打开设置
6、找到:扩展 -> C/C++/Formatting
在这里插入图片描述
其中:
(1) C_Cpp: Clang_format_fallback Style :当设置 clang-format 且没有 .clang-format 文件时,会使用这里选择的默认设置来设置格式

(2) C_Cpp: Clang_format_path:这个是 clang-format.exe 的绝对路径

  • C:\Users\xxx\.vscode\extensions\ms-vscode.cpptools-1.14.4-win32-x64\LLVM\bin\clang-format.exe

(3) C_Cpp: Clang_format_style:这个是 .clang-format 文件的路径

  • file:C:\Users\xxx\.vscode\extensions\ms-vscode.cpptools-1.14.4-win32-x64\LLVM\bin/.clang-format

若这里只设置为file,则从当前目录或父目录中的 .clang-format 文件加载样式,若当前目录或父目录中也没有 .clang-format 则使用 C_Cpp: Clang_format_fallback Style 中的设置


步骤二、步骤三为多余踩坑过程,可跳过。

  • 不需要生成 .clang-format 文件;
  • 不需要去改VSCode的配置;[捂脸,走了好多弯路]
  • 只需要下载了 C/C++插件 和 Clang-format 插件,执行步骤四就可以;

四、LLVM安装 + 添加到环境变量,格式化才可用

1、在安装了clang-format插件之后,进行代码格式化时还是会报错,The ‘clang-format’ command is not available. Please check your clang-format.executable user setting and ensure it is installed. 报错的大概意思是:命令不可用。

2、解决方案:下载LLVM
http://llvm.org/releases/3.7.0/LLVM-3.7.0-win32.exe
http://llvm.org/releases/3.7.0/LLVM-3.7.0-win64.exe

3、这步在安装的时候 直接选择安装到路径 中;(安装后可查看环境变量:我的电脑-属性-关于-高级系统设置-xxx D:\APPLICATION\LLVM\bin

4、重启VSCode! 就OK了
在这里插入图片描述

相关内容

热门资讯

云龙天池国家级自然保护区入选世... 转自:云南日报记者近日从云龙天池国家级自然保护区获悉,该保护区正式入选世界自然保护联盟绿色名录,成为...
芒果干里的“暖心账”​ 我 为 群 众 办 实 事我是楚雄彝族自治州楚雄市八角镇大麦地村委会泥期苴小组的鲁晓玲。天还没亮,新...
在亲戚借条上签名被判连带清偿责...   三湘都市报12月14日讯  欠钱逾期未还,双方公堂对簿,竟因借据上的“担保人”“连带担保人”起了...
学分能换“高级工”证书?湖南暂...   毕业就能拿到“高级工”的技能证书,实现“毕业即持证”,这是种什么样的体验?近日,安徽皖江工学院土...
长赣高铁湖南段首座隧道进洞施工     12月13日,位于浏阳市荷花街道和澄潭江镇的长赣高铁湖南段首座隧道——苏家庵隧道正式进洞。 ...