clang |
您所在的位置：网站首页 › format命令主要功能 › clang |
|
目录参考信息介绍安装命令格式基本使用使用.clang-format来实现自定义格式化导出.clang-format文件使用.clang-format文件.clang-format配置文件的各个选项的含义集成到vim中(官方给出了各种IDE或编辑器集成方式)常用命令clang-format-diff.py脚本
参考信息
官方参考：https://clang.llvm.org/docs/ClangFormat.html
入门博客参考：https://blog.csdn.net/softimite_zifeng/article/details/78357898
介绍
OVERVIEW: A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code. Clang-Format可用于格式化（排版）多种不同语言的代码。 其自带的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit等 若-style=google ，则表示应用Google的格式化风格 安装请看官网上的安装方式，或者Google一下你的OS安装方式吧。 这里给出我常用OS安装方式： macOS10.14.6 brew install clang-format ubuntu18.04 sudo apt install clang-format 命令格式USAGE: clang-format [options] [ ...] clang-format --help 建议至少浏览一遍帮助信息。 基本使用 // 以LLVM代码风格格式化main.cpp, 结果输出到stdout clang-format -style=LLVM main.cpp // 以LLVM代码风格格式化main.cpp, 结果直接写到main.cpp clang-format -style=LLVM -i main.cpp // 当然也支持对指定行格式化，格式化main.cpp的第1，2行 clang-format -lines=1:2 main.cpp 使用.clang-format来实现自定义格式化 导出.clang-format文件When the desired code formatting style is different from the available options, the style can be customized using the -style="{key: value, ...}" option or by putting your style configuration in the .clang-format or _clang-format file in your project’s directory and using clang-format -style=file. An easy way to create the .clang-format file is: clang-format -style=可选格式名 -dump-config > .clang-format # 可选格式最好写预设那那几个写最接近你想要的格式. 比如我想要接近google C++ style的。 我就写-style=google看了官网的介绍，我们知道我们可以使用.clang-format 文件来自定义格式。在使用时不再是-style=llvm等内置可选的那几种的格式。 使用我们自定义.clang-formart文件来格式化。指定方式为-style=file 注意：一般取.clang-format或_clang-format，因为自定义的排版格式文件只有取这两种名字之一，才能被Clang-Format识别。 现在对生成的.clang-format文件根据自己需求进行修改吧 使用.clang-format文件直接将修改后的文件放在和代码文件相同的文件夹中，并且设置格式化选项-style=file，即可以使用自定义的排版格式。 VS Code只要将该文件放在和代码文件相同的文件夹中即可，不需要额外的设置。 格式化文件放在代码文件的上一级文件夹中，也可以使用。(个人建议放在项目的根目录下。我看不少开源项目就是这么干的，嘿嘿嘿) 注意，文件名必须为.clang-format或_clang-format。 # 格式化的结果打到stdout(终端上) clang-format -style=file main.cc # 直接修改到文件 clang-format -style=file -i main.cc .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: '^( |
今日新闻 |
推荐新闻 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |