对.clang-format的部分注释

对.clang-Format的部分注释

知识浅薄，还有许多未理解之处，欢迎各位纠正、讨论。

clang-format简介

Clang-Format可用于格式化（排版）多种不同语言的代码。我们编写时需要注意代码的格式，通过该工具能够很好的管理代码格式。clang-format，它是基于clang的一个命令行工具，能够自动化格式：C、C++、Object-C代码，支持多种代码风格：Google、Chromium、LLVM、Mozilla、WebKit。也支持自定义风格（通过编写.clang-format文件）很方便的统一代码格式。

如果你使用Visual Studio Code编写代码（我当前用来编写C++），VSCode的C/C++插件自带了Clang-Format格式化工具，不仅拥有上述5种排版格式，还定义了自己的Visual Studio排版格式，且此格式是默认的排版格式（Ubuntu下格式化快捷键：Ctrl+Shift+I，Windows下格式化快捷键：Shift+Alt+F），VS Code格式化的具体内容可以参考官网：链接

配置文件说明

# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto Language: Cpp # BasedOnStyle: Google # 访问说明符(public、private等)的偏移 AccessModifierOffset: -1 # 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行) AlignAfterOpenBracket: Align # 连续赋值时，对齐所有等号 AlignConsecutiveAssignments: false # 连续声明时，对齐所有声明的变量名 AlignConsecutiveDeclarations: false # 左对齐逃脱换行(使用反斜杠换行)的反斜杠 换行时反斜杠位置：左对齐 AlignEscapedNewlines: Left # 水平对齐二元和三元表达式的操作数 AlignOperands: true # 对齐连续的尾随的注释 AlignTrailingComments: true # 允许函数声明的所有参数在放在下一行 AllowAllParametersOfDeclarationOnNextLine: true # 允许短的块放在同一行 AllowShortBlocksOnASingleLine: false # 允许短的case标签放在同一行 AllowShortCaseLabelsOnASingleLine: false # 允许短的函数放在同一行： None，InlineOnly(定义在类中),empty(空函数),Inline(定义在类中，空函数)，all AllowShortFunctionsOnASingleLine: All # 允许短的if语句保持在同一行 AllowShortIfStatementsOnASingleLine: true # 允许短的循环保持在同一行 AllowShortLoopsOnASingleLine: true # 总是在返回类型后换行(deprecated) AlwaysBreakAfterDefinitionReturnType: None # 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数), # AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义) AlwaysBreakAfterReturnType: None # 总是在多行string字面量前换行 AlwaysBreakBeforeMultilineStrings: true # 总是在template声明后换行 AlwaysBreakTemplateDeclarations: Yes # false表示函数实参要么都在同一行，要么都各自一行 BinPackArguments: true # false表示所有形参要么都在同一行，要么都各自一行 BinPackParameters: true # 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效 # 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似), # Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似), # Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom # 注：这里认为语句块也属于函数 BraceWrapping: # class定义后面 AfterClass: false # 控制语句后面 AfterControlStatement: false # enum定义后面 AfterEnum: false # 函数定义后面 （OC无效） AfterFunction: false # 命名空间定义后面 AfterNamespace: false # ObjC定义后面 AfterObjCDeclaration: false # Struct结构体定义后面 AfterStruct: false # Union定义后面 AfterUnion: false # Extern 定义后面 AfterExternBlock: false # Catch之前 BeforeCatch: false # Else之前 BeforeElse: false # 缩进大括号 IndentBraces: false # false 时，空方法体 {} 放在一行 SplitEmptyFunction: true # false 时，空记录（例如，类，结构或联合）{} 放在一行 SplitEmptyRecord: true # false 且 AfterNamespace == true 时 空命名空间体可放到一行: {} SplitEmptyNamespace: true # 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行) BreakBeforeBinaryOperators: None # 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似), # Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似), # Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom # 注：这里认为语句块也属于函数 BreakBeforeBraces: Attach # 继承列表的逗号前换行 BreakBeforeInheritanceComma: false # 在构造函数的初始化列表的逗号前换行 BreakInheritanceList: BeforeColon # 在三元运算符前换行 BreakBeforeTernaryOperators: true # 在构造函数的初始化列表的逗号前换行 BreakConstructorInitializersBeforeComma: false # 初始化列表前换行 BreakConstructorInitializers: BeforeColon # Java注解后换行 在Java文件中的字段上的每个注释之后中断。 BreakAfterJavaFieldAnnotations: false # 允许打破当格式化字符串。 BreakStringLiterals: true # Java注解后换行 每行字符的限制，0表示没有限制 ColumnLimit: 120 # 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变 CommentPragmas: '^ IWYU pragma:' # 紧凑 命名空间 CompactNamespaces: false # 构造函数的初始化列表要么都在同一行，要么都各自一行 ConstructorInitializerAllOnOneLineOrOnePerLine: true # 构造函数的初始化列表的缩进宽度 ConstructorInitializerIndentWidth: 4 # 延续的行的缩进宽度 ContinuationIndentWidth: 2 # 去除C++11的列表初始化的大括号{后和}前的空格 Cpp11BracedListStyle: true # 继承最常用的指针和引用的对齐方式 DerivePointerAlignment: false # 关闭格式化 DisableFormat: false # 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental) ExperimentalAutoDetectBinPacking: false # 固定命名空间注释 FixNamespaceComments: true # 需要被解读为foreach循环而不是函数调用的宏 ForEachMacros: # - foreach - Q_FOREACH - BOOST_FOREACH IncludeBlocks: Preserve # 对#include进行排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越小排序越靠前)， # 可以定义负数优先级从而保证某些#include永远在最前面 # include 分组排序方式 Preserve(按组排序) Merge（合并成一组排序）Regroup（按 IncludeCategories 重新分组排序） IncludeCategories: - Regex: '^' Priority: 2 - Regex: '^<.*\.h>' Priority: 1 - Regex: '^<.*' Priority: 2 - Regex: '.*' Priority: 3 # 指定正则表达式file-to-main-include映射中允许的后缀。 IncludeIsMainRegex: '([-_](test|unittest))?$' # 缩进case标签 case 是否缩进一级 IndentCaseLabels: true # 预处理代码缩进样式。None（不缩进）AfterHash（缩进） IndentPPDirectives: None # 缩进宽度 IndentWidth: 2 # 函数返回类型换行时，缩进函数声明或函数定义的函数名 IndentWrappedFunctionNames: false # JS 引号样式 Leave("",'') Single("") Double("") JavaScriptQuotes: Leave # JS import 是否需要换行 JavaScriptWrapImports: true # 保留在块开始处的空行(OC 没用) KeepEmptyLinesAtTheStartOfBlocks: false # 开始一个块的宏的正则表达式 MacroBlockBegin: '' # 结束一个块的宏的正则表达式 MacroBlockEnd: '' # 连续空行的最大数量 MaxEmptyLinesToKeep: 1 # 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All NamespaceIndentation: None # OC 协议根据 ColumnLimit 长度换行 实现内部缩进宽度 ObjCBinPackProtocolList: Never # 使用ObjC块时缩进宽度 使用 OC block 函数实现内部缩进宽度 ObjCBlockIndentWidth: 2 # 在ObjC的@property后添加一个空格 ObjCSpaceAfterProperty: false # 在ObjC的protocol列表前添加一个空格 ObjCSpaceBeforeProtocolList: true PenaltyBreakAssignment: 2 PenaltyBreakBeforeFirstCallParameter: 1 # 在一个注释中引入换行的penalty PenaltyBreakComment: 300 # 第一次在<<前换行的penalty PenaltyBreakFirstLessLess: 120 # 在一个字符串字面量中引入换行的penalty PenaltyBreakString: 1000 # 对于每个在行字符数限制之外的字符的penalty PenaltyBreakTemplateDeclaration: 10 PenaltyExcessCharacter: 1000000 # 将函数的返回类型放到它自己的行的penalty PenaltyReturnTypeOnItsOwnLine: 200 # 指针和引用的对齐: Left, Right, Middle PointerAlignment: Right #RawStringFormats: # - Delimiter: pb # Language: TextProto # BasedOnStyle: google # 允许重新排版注释 RawStringFormats: # 允许排序#include - Language: Cpp Delimiters: - cc - CC - cpp - Cpp - CPP - 'c++' - 'C++' CanonicalDelimiter: '' BasedOnStyle: google - Language: TextProto Delimiters: - pb - PB - proto - PROTO EnclosingFunctions: - EqualsProto - EquivToProto - PARSE_PARTIAL_TEXT_PROTO - PARSE_TEST_PROTO - PARSE_TEXT_PROTO - ParseTextOrDie - ParseTextProtoOrDie CanonicalDelimiter: '' BasedOnStyle: google ReflowComments: true SortUsingDeclarations: true # 在C风格类型转换后添加空格 SpaceAfterCStyleCast: false # template 模板关键字后面添加空格 SpaceAfterTemplateKeyword: true # 在赋值运算符之前添加空格 SpaceBeforeAssignmentOperators: true # 开圆括号之前添加一个空格: Never, ControlStatements, Always 初始化 c++ 11 对象的前面空格 # 初始化 c++ 11 对象的前面空格 SpaceBeforeCpp11BracedList: false # 构造函数：前加空格 SpaceBeforeCtorInitializerColon: true # 继承的：前面加空格 SpaceBeforeInheritanceColon: true # 开圆括号之前添加一个空格: Never, ControlStatements, Always SpaceBeforeParens: ControlStatements # false 清除 for 循环:前面的空格 for (auto v : values) {} SpaceBeforeRangeBasedForLoopColon: true # 在空的圆括号中添加空格 SpaceInEmptyParentheses: false # 在尾随的评论前添加的空格数(只适用于//) SpacesBeforeTrailingComments: 2 # 在尖括号的<后和>前添加空格 < int > SpacesInAngles: false # 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格 # 快捷数组 内部加空格 [ 1, 2, 3 ]; ：前加空格 f({a : 1, b : 2, c : 3}); SpacesInContainerLiterals: true # 在C风格类型转换的括号中添加空格 SpacesInCStyleCastParentheses: false # 在圆括号的(后和)前添加空格 SpacesInParentheses: false # 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响 SpacesInSquareBrackets: false # 标准: Cpp03, Cpp11, Auto Standard: Auto StatementMacros: - Q_UNUSED - QT_REQUIRE_VERSION # tab宽度 TabWidth: 2 # 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always UseTab: Never SortIncludes: false

vscode clang-format插件的使用

首先安装Clang-Format插件。

在“首选项”->“设置”中修改Clang-format: Executable的位置为实际位置，一般插件放置于D:\Users\xxx.vscode\extensions\ms-vscode.cpptools-x.xx.x\LLVM\bin目录下，这里需要指定到可执行文件，例如：D:\Users\jaron.vscode\extensions\ms-vscode.cpptools-0.29.0\LLVM\bin\clang-format.exe

设置C_Cpp: Clang_format_style和C_Cpp: Clang_format_fallback Style的值为file，可以指定从workspace目录中使用.clang-format文件。

将.clang-format文件拷贝到对应的工程目录下。

在打开的源代码下执行Alt + Shift + F即可格式化源代码，或者右键选择“格式化文档”。

命令行

用自定义配置格式化代码

/clang-format.exe --assume-filename=E:/test/.clang-format -i E:/test/src/main.c，指定.clang-format格式文件

或

clang-format.exe -style=file -i E:/test/src/main.c，会从当前目录查找.clang-format格式文件，找不到就向上一层目录寻找，再上一层……直到找到为止。

用内置配置格式化代码，这里指定Webkit

clang-format.exe -style=Webkit -i D:/test/src/main.c

命令行导出特定风格的配置文件（以Webkit为例）

clang-format.exe -dump-config -style=Webkit >.clang-format

以上即为本篇的所有内容，因学识与能力有限，如有不足之处，请多多包涵与指教！

MindSpore 昇腾

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。