VSCode安装clang-format插件及使用

VSCode安装clang-format插件及使用1.clang-format插件安装2.安装真正的格式化工具clang-format3.生成.clang-format配置文件并修改4.修改配置文件4.1全局配置文件修改4.2工作空间配置文件修改5.格式化代码1.clang-format插件安装插件安装方式分为直接安装和离线安装两种。直接安装在VSCode扩展里搜索clang-format安装排名第一的插件离线安装链接: VSCode插件商店里搜索clang-format选择下载次数最多的插件点击下载离线包然后在VSCode中安装离线包。下载插件安装包VSCode中安装离线包2.安装真正的格式化工具clang-formatLinux系统安装使用命令sudo apt install clang-format;windows系统安装这个工具集成在工具包LLVM中下载最新的.exe包下载完成后进行安装在安装目录的bin文件夹下可以找到clang-format.exe。3.生成.clang-format配置文件并修改生成.clang-format配置文件命令clang-format--styleLLVM--dump-config ./.clang-format如下基于LLVM风格进行的定制---BasedOnStyle:LLVMLanguage:Cpp #thisstyle 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:true# # 连续声明时对齐所有声明的变量名AlignConsecutiveDeclarations:true# 反斜杆换行的对齐方式 #--DontAlign-不进行对齐 #--Left-反斜杠靠左对齐 #--Right-反斜杠靠右对齐 # AlignEscapedNewlines:Right # 二元、三元表达式的对齐方式当表达式需要占用多行时 #--DontAlign-不进行对齐 #--Align-从操作符开始对齐 #--AlignAfterOperator-从操作数开始对齐AlignOperands:true# # 是否对齐行尾注释AlignTrailingComments:true# # 函数声明的所有参数在放在下一行 # AllowAllParametersOfDeclarationOnNextLine:false# # 是否允许短的代码块放在同一行 # AllowShortBlocksOnASingleLine:false# # 短的case标签和语句放在同一行 # AllowShortCaseLabelsOnASingleLine:true# # 短的函数放在同一行 #--None-不把短的函数放在同一行 #--InlineOnly-只把类内的内联函数放在同一行全局的空函数不放在同一行 #--Empty-只把空的函数放在同一行 #--Inline-把类内的内联函数放在同一行全局的空函数不放在同一行 #--All-都允许放在同一行AllowShortFunctionsOnASingleLine:InlineOnly # # 短的if语句保持在同一行 # AllowShortIfStatementsOnASingleLine:true# # 短的循环保持在同一行 # AllowShortLoopsOnASingleLine:true# # 总是在返回类型后换行:None,All,TopLevel(顶级函数不包括在类中的函数),# #AllDefinitions(所有的定义不包括声明),TopLevelDefinitions(所有的顶级函数的定义)# AlwaysBreakAfterReturnType:None # # 总是在多行string字面量前换行 # AlwaysBreakBeforeMultilineStrings:true# # 总是在template声明后换行AlwaysBreakTemplateDeclarations:true# # 函数调用时参数的放置规则 #--false-参数要么放在同一行要么每个参数占用一行 #--true-不做强制要求 # BinPackArguments:true# 函数声明、定义时参数的放置规则 #--false-参数要么放在同一行要么每个参数占用一行 #--true-不做强制要求 # BinPackParameters:true# 大括号放置风格 #--Attach-大括号紧随前方内容放在同一行 #--Linux-与 Attach 类似除了 函数、命名空间、类定义 的大括号放在下一行 #--Mozilla-与 Attach 类似除了枚举、函数、结构class\struct\union)的大括号放在下一行 #--Stroustrup-与 Attach 类似但函数定义前、catch前方、else前方的{}放在单独一行 #--Allman-总是换行 #--Whitesmiths-类似 Allman但{}和内部的语句对齐到同样位置 #--GNU-总是换行但在控制语句后的{}总是对齐到下一个位置 #--WebKit-与 Attach 类似但在函数定义前换行 #--Custom-依赖 BraceWrapping # 注这里认为语句块也属于函数BreakBeforeBraces:Custom # 大括号换行只有当BreakBeforeBraces设置为Custom时才有效BraceWrapping:#class定义后面AfterClass:true# 控制语句后面AfterControlStatement:true#enum定义后面AfterEnum:true# 函数定义后面AfterFunction:true# 命名空间定义后面AfterNamespace:true# ObjC定义后面AfterObjCDeclaration:true# struct定义后面AfterStruct:true# union定义后面AfterUnion:true# extern之后AfterExternBlock:true# catch之前BeforeCatch:true#else之前BeforeElse:true# 继续缩进大括号IndentBraces:false# 分离空函数 # # 当空白函数的{}和函数名称不需要放在同一行时是否拆分函数体SplitEmptyFunction:true# 分离空语句 # #当空白结构(class\struct\union)的{}需要放在单独的行时是否拆分{}SplitEmptyRecord:true# 分离空命名空间 # # 当空白的命名空间的{}需要放在单独的行时是否拆分{}SplitEmptyNamespace:true# # 在二元运算符前换行:None(在操作符后换行),NonAssignment(在非赋值的操作符前换行),All(在操作符前换行)BreakBeforeBinaryOperators:NonAssignment # BreakBeforeInheritanceComma:false# # 在三元运算符前换行 # 当三元表达式不能放在同一行时是否在三元操作符前方换行 #--true-操作符位于新行的首部 #--false-操作符位于上一行的尾部BreakBeforeTernaryOperators:true# BreakConstructorInitializersBeforeComma:false# # 构造函数初始化列表分割方式 #--BeforeColon-在冒号:前方分割冒号位于行首逗号,位于行尾 #--BeforeComma-在冒号和逗号前方分割冒号和逗号都位于行首并且对齐 #--AfterColon-在冒号和逗号后方分割冒号和逗号位于行尾BreakConstructorInitializers:BeforeColon # # 是否在每个java注解后方换行 # BreakAfterJavaFieldAnnotations:false# # 是否分割过长的字符串 # BreakStringLiterals:false# # 每行字符长度的限制0表示没有限制ColumnLimit:0# # 用于匹配注释信息的正则表达式被匹配的行不会做任何修改 # CommentPragmas:^ IWYU pragma:# 是否压缩紧接的命名空间 #--true-将紧跟的命名空间放在同一行 #--false-每个命名空间位于新的一行CompactNamespaces:false# # 构造函数的初始化列表要么都在同一行要么都各自一行 #--true-如果可能初始化列表放在同一行如果不满足长度选择则每个单独放一行 #--false-初始化列表可以随意放置 # ConstructorInitializerAllOnOneLineOrOnePerLine:false# # 构造函数的初始化列表和基类集成列表的对齐宽度ConstructorInitializerIndentWidth:4# # 延续语句的对齐宽度ContinuationIndentWidth:4# # 去除C11的列表初始化的大括号{后和}前的空格Cpp11BracedListStyle:true# 是否自动分析指针的对齐方式 #--true-自动分析并使用指针的对齐方式若无法分析则使用 PointerAlignment #--false-不自动分析 # DerivePointerAlignment:true# 是否禁用格式化DisableFormat:false# ExperimentalAutoDetectBinPacking:false# 是否自动修正命名空间的结束注释 #--true-在短的命名空间尾部自动添加或修改错误的命名空间结束注释 #--false-不自动修正FixNamespaceComments:true# foreach 循环ForEachMacros:-foreach-Q_FOREACH-BOOST_FOREACH# 多个 include 块有空行分隔的include排序时的分组规则 #--Preserve-保留原有的块分隔各自排序 #--Merge-将所有的块视为同一个然后进行排序 #--Regroup-将所有的块视为同一个进行排序然后按照 IncludeCategories 的规则进行分组IncludeBlocks:Preserve # IncludeCategories:#-Regex:^ext/.*\.h# Priority:2#-Regex:^.*\.h# Priority:1#-Regex:^.*# Priority:2#-Regex:.*# Priority:3# IncludeIsMainRegex:([-_](test|unittest))?$# # 缩进case标签 #--true-case不与switch对齐 #--false-case和switch对齐IndentCaseLabels:false#预处理命令(#if\#ifdef\#endif等)的缩进规则 #--None-不进行缩进 #--AfterHash-在前导#后缩进#放在最左侧之后的语句参与缩进 #--BeforeHash-在前导#前进行缩进IndentPPDirectives:AfterHash # # 函数返回类型换行时缩进函数声明或函数定义的函数名 # IndentWrappedFunctionNames:false# JavaScript 中的字符串引号规则 #--Leave-保持原样 #--Single-全部使用单引号 #--Double-全部使用双引号JavaScriptQuotes:Leave # 是否在 JavaScript 的import/export语句后换行 # JavaScriptWrapImports:true# # 保留在块开始处的空行 #--true-保留块起始的空行 #--false-删除块起始的空行KeepEmptyLinesAtTheStartOfBlocks:true# 用于识别宏定义型块起始的正则表达式 # MacroBlockBegin:# 用于识别宏定义型块结束的正则表达式 # MacroBlockEnd:# # 连续空行的最大数量MaxEmptyLinesToKeep:1# # 命名空间内部的缩进规则 #--None-都不缩进 #--Inner-只缩进嵌套的命名空间内容 #--All-缩进所有命名空间内容NamespaceIndentation:None # Objective-C相关配置 # ObjCBlockIndentWidth:2# ObjCSpaceAfterProperty:false# ObjCSpaceBeforeProtocolList:false# PenaltyBreakAssignment:2# PenaltyBreakBeforeFirstCallParameter:1# PenaltyBreakComment:300# PenaltyBreakFirstLessLess:120# PenaltyBreakString:1000# PenaltyExcessCharacter:1000000# PenaltyReturnTypeOnItsOwnLine:200# #指针和引用(*和)的对齐规则 #--Left-*靠近左侧 #--Right-*靠近右侧 #--Middle-*放在中间 #NOTE:在 SpaceAroundPointerQualifiers 为 Default # 且 DerivePointerAlignment 失效后启用PointerAlignment:Right # RawStringFormats:#-Delimiter:pb # Language:TextProto # BasedOnStyle:google # # 重新排版注释ReflowComments:false# # 重新排序#include #--Never-不进行排序 #--CaseSensitive-排序时大小写敏感 #--CaseInsensitive-排序时大小写不敏感SortIncludes:false# java 中静态import的排序规则 #--Before-静态放在非静态前方 #--After-静态放在非静态后方 # SortJavaStaticImport:Before # # 重新排序using声明SortUsingDeclarations:false# # 在C风格类型转换后添加空格SpaceAfterCStyleCast:false# # 在Template关键字后面添加空格SpaceAfterTemplateKeyword:true# # 在赋值运算符之前添加空格SpaceBeforeAssignmentOperators:true# # 在C11的初始化列表前加空格 # SpaceBeforeCpp11BracedList:true# 在构造函数的初始化冒号:前加空格 # SpaceBeforeCtorInitializerColon:true# 在构造函数的继承冒号:前加空格 # SpaceBeforeInheritanceColon:true# 小括号()前加空格的规则 #--Never-从不加空格 #--ControlStatements-只在控制语句(for/if/while...)时加空格 #--ControlStatementsExceptForEachMacros-类型 ControlStatements只是不再 ForEach 后加空格 #--Always-总是添加空格 #--NonEmptyParentheses-类似 Always只是不再空白括号前加空格SpaceBeforeParens:Never # 在for循环的冒号:前加空格 # SpaceBeforeRangeBasedForLoopColon:true# # 在空白的小括号()中添加空格SpaceInEmptyParentheses:false# #在行尾的注释前添加的空格数(只适用于//)SpacesBeforeTrailingComments:1# # 在尖括号的后,和前添加空格SpacesInAngles:false# #在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格SpacesInContainerLiterals:true# # 在C风格类型转换的括号中添加空格SpacesInCStyleCastParentheses:false# # 在圆括号的(后,和)前添加空格SpacesInParentheses:false# 在中括号中加空格 # 当中括号内没有数据时不受本规则影响如空白的lambda 捕获表、不定长度的数组声明SpacesInSquareBrackets:false# 语言标准:Cpp03,Cpp11,AutoStandard:Auto # # tab宽度TabWidth:4# # 使用tab字符:Never,ForIndentation,ForContinuationAndIndentation,AlwaysUseTab:ForIndentation...4.修改配置文件VSCode配置文件分为全局配置文件和工作空间配置文件全局配置文件对全部工作空间有效工作空间配置文件对当前工作空间有效。可以同时修改全局配置文件和当前工作空间配置文件当前工作空间配置将覆盖全局配置。4.1全局配置文件修改在VSCode中按“F1”按键输入“setting”点击下图选项可打开全局的settings.json文件在配置文件里添加如下配置{ // clang-format 扩展的配置 clang-format.style : file, clang-format.assumeFilename: /home/user/.clang-format, clang-format.executable: /usr/bin/clang-format, clang-format.fallbackStyle: Google, editor.defaultFormatter: xaver.clang-format }其中clang-format.assumeFilename为.clang-format配置文件的路径clang-format.executable为clang-format程序的路径。4.2工作空间配置文件修改在VSCode中按“F1”按键输入“setting”点击下图选项可打开当前工作空间的settings.json文件在配置文件里添加如下配置{ // clang-format 扩展的配置 clang-format.style : file, clang-format.assumeFilename: /home/user/.clang-format, clang-format.executable: /usr/bin/clang-format, clang-format.fallbackStyle: Google, editor.defaultFormatter: xaver.clang-format }其中clang-format.assumeFilename为.clang-format配置文件的路径clang-format.executable为clang-format程序的路径。5.格式化代码在代码页面按AltShiftf。全选代码,鼠标右键,使用…格式化代码(Format Document With...)选择Clang-Format。