• VS Code C++ 代码格式化方法(clang-format)


    转自:https://blog.csdn.net/core571/article/details/82867932?depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromBaidu-1&utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromBaidu-1

    前提条件
    安装扩展C/C++,扩展程序将自动安装clang-format。clang-format默认安装路径为c:Userswqr57.vscodeextensionsms-vscode.cpptools-0.18.1/bin/../LLVM/bin/clang-format.exe

    首选项设置
    打开首选项设置(ctrl + ,),搜索format .

    可勾选format on save 自动保存。

    C_Cpp: Clang_format_style 决定格式化形式,若为file,则调用在workspace中的.clang-format

    C_Cpp: Clang_format_fallback Style ,若上图变量为file,但无.clang-format文件则按照此处规则。

    .clang-format
    powershell中输入

    clang-format -style=llvm -dump-config > .clang-format
    产生模板

    决定自定义格式化

    ---
    # 语言: 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: '^(<|"(gtest|isl|json)/)'
    Priority: 3
    - Regex: '.*'
    Priority: 1
    # 缩进case标签
    IndentCaseLabels: true

    IndentPPDirectives: AfterHash
    # 缩进宽度
    IndentWidth: 4
    # 函数返回类型换行时,缩进函数声明或函数定义的函数名
    IndentWrappedFunctionNames: false
    # 保留在块开始处的空行
    KeepEmptyLinesAtTheStartOfBlocks: false
    # 开始一个块的宏的正则表达式
    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

    SpaceAfterTemplateKeyword: true

    # 在赋值运算符之前添加空格
    SpaceBeforeAssignmentOperators: true
    # 开圆括号之前添加一个空格: Never, ControlStatements, Always
    SpaceBeforeParens: ControlStatements
    # 在空的圆括号中添加空格
    SpaceInEmptyParentheses: false
    # 在尾随的评论前添加的空格数(只适用于//)
    SpacesBeforeTrailingComments: 2
    # 在尖括号的<后和>前添加空格
    SpacesInAngles: false
    # 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
    SpacesInContainerLiterals: false
    # 在C风格类型转换的括号中添加空格
    SpacesInCStyleCastParentheses: false
    # 在圆括号的(后和)前添加空格
    SpacesInParentheses: false
    # 在方括号的[后和]前添加空格,lamda表达式和未指明大小的数组的声明不受影响
    SpacesInSquareBrackets: false
    # 标准: Cpp03, Cpp11, Auto
    Standard: Cpp11
    # tab宽度
    TabWidth: 4
    # 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
    UseTab: Never
    快捷键
    shift+alt+f 文档格式化

    ctrl+k ctrl+f 选择快注释

    参考链接
    Clang-Format格式化选项介绍

    C/C++ for Visual Studio Code

    ClangFormat
    ————————————————
    版权声明:本文为CSDN博主「core571」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
    原文链接:https://blog.csdn.net/core571/java/article/details/82867932

  • 相关阅读:
    Java语言
    包名规范
    带参数的方法
    成员变量和局部变量
    Java数据类型
    java反射机制
    JDK安装
    注释
    二维数组
    数组的经典排序
  • 原文地址:https://www.cnblogs.com/x_wukong/p/12643095.html
Copyright © 2020-2023  润新知