在 Visual Studio Code 中配置 Clang-Format 格式化 (排版) 工具

在 Visual Studio Code 中配置 Clang-Format 格式化 {排版} 工具1. Install clang-format on Linux2. Create the .clang-format file3. Install the Clang-Format extension4. Configure ClangFormat options5. Code formatting6. 自定义 clang-format 代码格式规范ReferencesClang Formathttps://clang.llvm.org/docs/ClangFormat.htmlClang-Format Style Optionshttps://clang.llvm.org/docs/ClangFormatStyleOptions.htmlclang-formatis located inclang/tools/clang-formatand can be used to format C/C/Java/JavaScript/JSON/Objective-C/Protobuf/C# code.1. Installclang-formaton LinuxInstallclang-formatby entering the following commandsyongqiangyongqiang:~$ sudo apt update yongqiangyongqiang:~$ sudo apt-cache search clang-format # This command will list all the available versions. yongqiangyongqiang:~$ sudo apt install clang-format -yDisplay the version of this programyongqiangyongqiang:~$ clang-format --version clang-format version 10.0.0-4ubuntu1 yongqiangyongqiang:~$ yongqiangyongqiang:~$ whereis clang-format clang-format: /usr/bin/clang-format /usr/share/man/man1/clang-format.1.gz yongqiangyongqiang:~$ yongqiangyongqiang:~$ which clang-format /usr/bin/clang-format yongqiangyongqiang:~$Ifclang-formatis in your system path, you shouldn’t need to do anything.Create a symbolic link for clang-format:sudo ln -s /usr/bin/clang-format-9.0 /usr/bin/clang-format sudo ln -s /usr/bin/clang-format-6.0 /usr/bin/clang-format2. Create the.clang-formatfileAn easy way to get a valid.clang-formatfile containing all configuration options of a certain predefined style is:clang-format -stylegoogle -dump-config .clang-format clang-format -stylellvm -dump-config .clang-formatyongqiangyongqiang:~/software$ clang-format -stylegoogle -dump-config .clang-format yongqiangyongqiang:~/software$ ll total 16 drwxr-xr-x 2 yongqiang yongqiang 4096 May 8 22:46 ./ drwxr-xr-x 13 yongqiang yongqiang 4096 May 7 10:10 ../ -rw-r--r-- 1 yongqiang yongqiang 4523 May 8 22:46 .clang-format yongqiangyongqiang:~/software$The style used for all options not specifically set in the configuration. Possible values:LLVM: A style complying with the LLVM coding standardsGoogle: A style complying with Google’s C style guideChromium: A style complying with Chromium’s style guideMozilla:A style complying with Mozilla’s style guideWebKit: A style complying with WebKit’s style guideMicrosoft: A style complying with Microsoft’s style guideGNU: A style complying with the GNU coding standards3. Install the Clang-Format extension4. Configure ClangFormat optionsFile - Preferences - Settings - Remote [*] - Clang-Format configurationAssume Filename:/home/yongqiang/software/.clang-formatWhen reading from stdin, clang-format assumes this filename to look for a style config file (with-stylefile) and to determine the language.Executable:/usr/bin/clang-formatclang-format executable pathFallback Style:Googleclang-format fallback style. (-fallback-stylevalue, value can be none, LLVM, Google, Chromium, Mozilla, WebKit)Style:fileclang-format style.(-stylevalue, value can be file, LLVM, Google, Chromium, Mozilla, WebKit or json configure)5. Code formattingThe C/C extension for Visual Studio Code supports source code formatting using clang-format which is included with the extension.Format Document With…Configure Default Formatter…Clang-FormatYou can format an entire file withFormat Document(ShiftAltF) or just the current selection withFormat Selection(CtrlK CtrlF) in right-click context menu. You can also configure auto-formatting with the following settings:editor.formatOnSave- to format when you save your file.editor.formatOnType- to format as you type (triggered on the;character).By default, the clang-format style is set to “file” which means it looks for a.clang-formatfile inside your workspace. If the.clang-formatfile is found, formatting is applied according to the settings specified in the file. If no.clang-formatfile is found in your workspace, formatting is applied based on a default style specified in theC_Cpp.clang_format_fallbackStylesetting instead.6. 自定义 clang-format 代码格式规范可以将生成的.clang-format文件提交到 Git 仓库。这样团队里的每一个人在按下“格式化代码”快捷键时代码风格都能保持绝对一致。clang-format -stylegoogle -dump-config .clang-format以 Google 的代码风格为蓝本生成一份完整的 clang-format 配置文件 (命名为.clang-format) 并保存到当前目录下。-stylegoogle: 指定基础的代码风格-dump-config: 导出/转储完整的配置参数 .clang-format: 重定向输出到文件yongqiangyongqiang:~/software$ clang-format -stylegoogle -dump-config .clang-format yongqiangyongqiang:~/software$ ll total 16 drwxr-xr-x 2 yongqiang yongqiang 4096 May 8 22:46 ./ drwxr-xr-x 13 yongqiang yongqiang 4096 May 7 10:10 ../ -rw-r--r-- 1 yongqiang yongqiang 4523 May 8 22:46 .clang-format yongqiangyongqiang:~/software$ yongqiangyongqiang:~/software$ cat ./.clang-format --- Language: Cpp # BasedOnStyle: Google AccessModifierOffset: -1 AlignAfterOpenBracket: Align AlignConsecutiveMacros: false AlignConsecutiveAssignments: false AlignConsecutiveDeclarations: false AlignEscapedNewlines: Left AlignOperands: true AlignTrailingComments: true AllowAllArgumentsOnNextLine: true AllowAllConstructorInitializersOnNextLine: true AllowAllParametersOfDeclarationOnNextLine: true AllowShortBlocksOnASingleLine: Never AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: All AllowShortLambdasOnASingleLine: All AllowShortIfStatementsOnASingleLine: WithoutElse AllowShortLoopsOnASingleLine: true AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: true AlwaysBreakTemplateDeclarations: Yes BinPackArguments: true BinPackParameters: true BraceWrapping: AfterCaseLabel: false AfterClass: false AfterControlStatement: false AfterEnum: false AfterFunction: false AfterNamespace: false AfterObjCDeclaration: false AfterStruct: false AfterUnion: false AfterExternBlock: false BeforeCatch: false BeforeElse: false IndentBraces: false SplitEmptyFunction: true SplitEmptyRecord: true SplitEmptyNamespace: true BreakBeforeBinaryOperators: None BreakBeforeBraces: Attach BreakBeforeInheritanceComma: false BreakInheritanceList: BeforeColon BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false BreakConstructorInitializers: BeforeColon BreakAfterJavaFieldAnnotations: false BreakStringLiterals: true ColumnLimit: 80 CommentPragmas: ^ IWYU pragma: CompactNamespaces: false ConstructorInitializerAllOnOneLineOrOnePerLine: true ConstructorInitializerIndentWidth: 4 ContinuationIndentWidth: 4 Cpp11BracedListStyle: true DeriveLineEnding: true DerivePointerAlignment: true DisableFormat: false ExperimentalAutoDetectBinPacking: false FixNamespaceComments: true ForEachMacros: - foreach - Q_FOREACH - BOOST_FOREACH IncludeBlocks: Regroup IncludeCategories: - Regex: ^ext/.*\.h Priority: 2 SortPriority: 0 - Regex: ^.*\.h Priority: 1 SortPriority: 0 - Regex: ^.* Priority: 2 SortPriority: 0 - Regex: .* Priority: 3 SortPriority: 0 IncludeIsMainRegex: ([-_](test|unittest))?$ IncludeIsMainSourceRegex: IndentCaseLabels: true IndentGotoLabels: true IndentPPDirectives: None IndentWidth: 2 IndentWrappedFunctionNames: false JavaScriptQuotes: Leave JavaScriptWrapImports: true KeepEmptyLinesAtTheStartOfBlocks: false MacroBlockBegin: MacroBlockEnd: MaxEmptyLinesToKeep: 1 NamespaceIndentation: None ObjCBinPackProtocolList: Never ObjCBlockIndentWidth: 2 ObjCSpaceAfterProperty: false ObjCSpaceBeforeProtocolList: true PenaltyBreakAssignment: 2 PenaltyBreakBeforeFirstCallParameter: 1 PenaltyBreakComment: 300 PenaltyBreakFirstLessLess: 120 PenaltyBreakString: 1000 PenaltyBreakTemplateDeclaration: 10 PenaltyExcessCharacter: 1000000 PenaltyReturnTypeOnItsOwnLine: 200 PointerAlignment: Left RawStringFormats: - 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 SortIncludes: true SortUsingDeclarations: true SpaceAfterCStyleCast: false SpaceAfterLogicalNot: false SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeCpp11BracedList: false SpaceBeforeCtorInitializerColon: true SpaceBeforeInheritanceColon: true SpaceBeforeParens: ControlStatements SpaceBeforeRangeBasedForLoopColon: true SpaceInEmptyBlock: false SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 2 SpacesInAngles: false SpacesInConditionalStatement: false SpacesInContainerLiterals: true SpacesInCStyleCastParentheses: false SpacesInParentheses: false SpacesInSquareBrackets: false SpaceBeforeSquareBrackets: false Standard: Auto StatementMacros: - Q_UNUSED - QT_REQUIRE_VERSION TabWidth: 8 UseCRLF: false UseTab: Never ... yongqiangyongqiang:~/software$Yongqiang Cheng 自定义Google 风格可能 90% 符合你的习惯但有些细节你想改 (比如 Google 默认缩进 2 空格你想改成 4 空格)。生成这个文件后你可以直接打开它修改其中的某几行。ColumnLimit: 120 (单行代码最大长度限制)The column limit.允许单行代码最多包含 120 个字符。超过 120 个字符时clang-format 才会强制将代码拆分换行。IndentWidth: 4 (缩进宽度)The number of columns to use for indentation.每一次代码缩进都使用 4 个字符宽度。TabWidth: 4 (Tab 键宽度)The number of columns used for tab stops.定义一个制表符 (Tab 键) 在显示时应该占据几个字符的宽度。References[1] Yongqiang Cheng (程永强), https://yongqiang.blog.csdn.net/[2] Edit C in Visual Studio Code, https://code.visualstudio.com/docs/cpp/cpp-ide[3] Clang-Format Style Options, https://clang.llvm.org/docs/ClangFormatStyleOptions.html[4] Options, Text Editor, C/C, Formatting, https://learn.microsoft.com/en-us/visualstudio/ide/reference/options-text-editor-c-cpp-formatting[5] 在 Visual Studio Code 中配置 Clang-Format 格式化 (排版) 工具, https://mp.weixin.qq.com/s/b4Qv78TleWn400PINP_Xzw