• 【vscode使用clang-format格式化代码】


    为什么使用clang-format

    在使用vscode远程开发代码的时候,我们希望能够在保存代码的时候自动格式化代码,这里提到clang-format这工具。这里的全部流程是在ubuntu上操作

    安装clang-format

    sudo clang-format
    
    • 1

    生成.clang-format

    在工程目录生成.clang-format文件,这里支持多种格式模板llvm, google, chromium, mozilla, webkit

    clang-format -style=Google -dump-config > .clang-format
    
    • 1

    .clang-format文件说明

    我们可以修改.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
    ...
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118
    • 119
    • 120
    • 121
    • 122
    • 123
    • 124
    • 125
    • 126
    • 127
    • 128
    • 129
    • 130
    • 131
    • 132
    • 133
    • 134
    • 135
    • 136
    • 137
    • 138
    • 139
    • 140
    • 141
    • 142
    • 143
    • 144
    • 145
    • 146
    • 147
    • 148
    • 149
    • 150
    • 151
    • 152
    • 153
    • 154
    • 155
    • 156
    • 157
    • 158
    • 159
    • 160
    • 161
    • 162
    • 163
    • 164
    • 165
    • 166
    • 167
    • 168
    • 169
    • 170
    • 171
    • 172
    • 173
    • 174
    • 175

    使vscode支持.clang-format

    当然vscode有自己的clang-format的插件,但是使用不是很灵活,因此我们现在使用上面生成的.clang-format文件,并且可以自定义

    修改配置
    在这里插入图片描述

    设置保存自动格式化代码

    在这里插入图片描述

  • 相关阅读:
    VisualAssist 10.9.2 Crack-2022-09-15
    软考考试多少分算通过?
    浮点数在内存中的存储方式
    java计算机毕业设计ssm+vue高校人事管理系统
    Mybatis的Mapper文件报错:Tag name expected
    20天零基础自学Python | Day9 List列表用法大全
    Scala面向对象的特征
    GitHub Copilot Chat将于12月全面推出;DeepLearning.AI免费新课
    阿里云免费SSL证书过期替换
    (2)数据库mongodb 终端 和 vscode创建数据库 数据导入导出
  • 原文地址:https://blog.csdn.net/xf8964/article/details/126082795