代码格式化工具:clang

您所在的位置:网站首页 vscode格式化代码工具 代码格式化工具:clang

代码格式化工具:clang

2023-04-10 04:05| 来源: 网络整理| 查看: 265

IDE: Visual Studio Code

Language: C/C++

格式化工具: clang-format

安装

vscode安装扩展C/C++,扩展程序将自动安装clang-format:

配置首选项

打开首选项

快捷键: Command + ,

搜索 clang-format进行配置

配置生效快捷键

当前文件全文格式化

Shift + option + F

选择块格式化

Command + K

Command + F

配置格式化主题

配置项 C_Cpp: Clang_format_fallback Style

可选主题 Visual Studio LLVM Google Chromium Mozilla WebKit none {key: value, …} 自定义key-value写法参考 { BasedOnStyle: Google, IndentWidth: 4, IndentCaseLabels: false, AccessModifierOffset: -4, AlignTrailingComments: true } 常用配置项 # 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto Language: Cpp # 基于某一主题上的修改 BasedOnStyle: Google # 缩进宽度 IndentWidth: 4 # 缩进case标签 IndentCaseLabels: false # 访问说明符(public、private等)的偏移 AccessModifierOffset: -4 # 每行字符的限制,0表示没有限制 ColumnLimit: 80 # 对齐连续的尾随的注释 AlignTrailingComments: true # 允许函数声明的所有参数在放在下一行 AllowAllParametersOfDeclarationOnNextLine: false # 允许短的if语句保持在同一行 AllowShortIfStatementsOnASingleLine: false # 允许短的case标签放在同一行 AllowShortCaseLabelsOnASingleLine: true # 允许短的循环保持在同一行 AllowShortLoopsOnASingleLine: false # 允许排序#include SortIncludes: true

更多配置项参考:

VS Code C++ 代码格式化方法(clang-format) Clang-Format Style Options 配置格式化形式

配置项 C_Cpp: Clang_format_style

默认是 file, 将会调用在当前工程下的 .clang-format 文件

注: 该种格式化配置, 优先级比上条配置方式高!

主题文件可通过clang-format工具生成, 例

# 若未安装则执行 brew install clang-format # 生成主题文件 clang-format -style=Google -dump-config > .clang-format 配置文件保存时自动格式化

按 Command + S 保存文件时, 或关闭当前文件的编辑, 将会触发自动格式化代码

配置行末加 ; 时自动格式化

类似 Xcode, 一条语句后加分号, 将会自动触发自动格式化代码

最后附上我使用的 代码格式化样式:

{BasedOnStyle: Google, IndentWidth: 4, AccessModifierOffset: -4,AllowShortLoopsOnASingleLine: true,AllowShortIfStatementsOnASingleLine: true,AlignTrailingComments: true} update :20.11.13 "C_Cpp.clang_format_fallbackStyle": "{BasedOnStyle: Google, IndentWidth: 4, AccessModifierOffset: -4,AllowShortLoopsOnASingleLine: false,AllowShortIfStatementsOnASingleLine: true, AlignConsecutiveAssignments: true} ",

自定义样式参考表

--- # 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto Language: Cpp # BasedOnStyle: LLVM # 访问说明符(public、private等)的偏移 AccessModifierOffset: -2 # 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行) AlignAfterOpenBracket: Align # 连续赋值时,对齐所有等号 AlignConsecutiveAssignments: true # 连续声明时,对齐所有声明的变量名 AlignConsecutiveDeclarations: true AlignEscapedNewlines: Right # 左对齐逃脱换行(使用反斜杠换行)的反斜杠 #AlignEscapedNewlinesLeft: true # 水平对齐二元和三元表达式的操作数 AlignOperands: true # 对齐连续的尾随的注释 AlignTrailingComments: true # 允许函数声明的所有参数在放在下一行 AllowAllParametersOfDeclarationOnNextLine: false # 允许短的块放在同一行 AllowShortBlocksOnASingleLine: true # 允许短的case标签放在同一行 AllowShortCaseLabelsOnASingleLine: true # 允许短的函数放在同一行: 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: false # 大括号换行,只有当BreakBeforeBraces设置为Custom时才有效 BraceWrapping: # class定义后面 AfterClass: false # 控制语句后面 AfterControlStatement: false # enum定义后面 AfterEnum: false # 函数定义后面 AfterFunction: true # 命名空间定义后面 AfterNamespace: false # ObjC定义后面 AfterObjCDeclaration: false # struct定义后面 AfterStruct: true # union定义后面 AfterUnion: true AfterExternBlock: false # catch之前 BeforeCatch: true # else之前 BeforeElse: true # 缩进大括号 IndentBraces: false SplitEmptyFunction: true SplitEmptyRecord: true SplitEmptyNamespace: true # 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行) BreakBeforeBinaryOperators: None # 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义,与Attach类似), # Mozilla(除枚举、函数、记录定义,与Attach类似), Stroustrup(除函数定义、catch、else,与Attach类似), # Allman(总是在大括号前换行), GNU(总是在大括号前换行,并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom # 注:这里认为语句块也属于函数 BreakBeforeBraces: Custom # 在三元运算符前换行 BreakBeforeTernaryOperators: false # 在构造函数的初始化列表的逗号前换行 BreakConstructorInitializersBeforeComma: false BreakConstructorInitializers: BeforeColon # 每行字符的限制,0表示没有限制 ColumnLimit: 80 # 描述具有特殊意义的注释的正则表达式,它不应该被分割为多行或以其它方式改变 CommentPragmas: '^ IWYU pragma:' CompactNamespaces: false # 构造函数的初始化列表要么都在同一行,要么都各自一行 ConstructorInitializerAllOnOneLineOrOnePerLine: false # 构造函数的初始化列表的缩进宽度 ConstructorInitializerIndentWidth: 4 # 延续的行的缩进宽度 ContinuationIndentWidth: 4 # 去除C++11的列表初始化的大括号{后和}前的空格 Cpp11BracedListStyle: true # 继承最常用的指针和引用的对齐方式 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