VS Code C++ 代码格式化方法(clang-format)
轉(zhuǎn)自: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
前提條件
安裝擴(kuò)展C/C++,擴(kuò)展程序?qū)⒆詣?dòng)安裝clang-format。clang-format默認(rèn)安裝路徑為c:Userswqr57.vscodeextensionsms-vscode.cpptools-0.18.1/bin/../LLVM/bin/clang-format.exe
首選項(xiàng)設(shè)置
打開首選項(xiàng)設(shè)置(ctrl + ,),搜索format .
可勾選format on save 自動(dòng)保存。
C_Cpp:Clang_format_style 決定格式化形式,若為file,則調(diào)用在workspace中的.clang-format
C_Cpp:Clang_format_fallback Style ,若上圖變量為file,但無.clang-format文件則按照此處規(guī)則。
.clang-format
powershell中輸入
clang-format -style=llvm -dump-config > .clang-format
產(chǎn)生模板
決定自定義格式化
---
# 語言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language: Cpp
# BasedOnStyle: LLVM
# 訪問說明符(public、private等)的偏移
AccessModifierOffset: -2
# 開括號(開圓括號、開尖括號、開方括號)后的對齊: Align, DontAlign, AlwaysBreak(總是在開括號后換行)
AlignAfterOpenBracket: Align
# 連續(xù)賦值時(shí),對齊所有等號
AlignConsecutiveAssignments: true
# 連續(xù)聲明時(shí),對齊所有聲明的變量名
AlignConsecutiveDeclarations: true
AlignEscapedNewlines: Right
# 左對齊逃脫換行(使用反斜杠換行)的反斜杠
#AlignEscapedNewlinesLeft: true
# 水平對齊二元和三元表達(dá)式的操作數(shù)
AlignOperands: true
# 對齊連續(xù)的尾隨的注釋
AlignTrailingComments: true
# 允許函數(shù)聲明的所有參數(shù)在放在下一行
AllowAllParametersOfDeclarationOnNextLine: false
# 允許短的塊放在同一行
AllowShortBlocksOnASingleLine: true
# 允許短的case標(biāo)簽放在同一行
AllowShortCaseLabelsOnASingleLine: true
# 允許短的函數(shù)放在同一行: None, InlineOnly(定義在類中), Empty(空函數(shù)), Inline(定義在類中,空函數(shù)), All
AllowShortFunctionsOnASingleLine: Empty
# 允許短的if語句保持在同一行
AllowShortIfStatementsOnASingleLine: false
# 允許短的循環(huán)保持在同一行
AllowShortLoopsOnASingleLine: false
# 總是在定義返回類型后換行(deprecated)
AlwaysBreakAfterDefinitionReturnType: None
# 總是在返回類型后換行: None, All, TopLevel(頂級函數(shù),不包括在類中的函數(shù)),
# AllDefinitions(所有的定義,不包括聲明), TopLevelDefinitions(所有的頂級函數(shù)的定義)
AlwaysBreakAfterReturnType: None
# 總是在多行string字面量前換行
AlwaysBreakBeforeMultilineStrings: false
# 總是在template聲明后換行
AlwaysBreakTemplateDeclarations: false
# false表示函數(shù)實(shí)參要么都在同一行,要么都各自一行
BinPackArguments: true
# false表示所有形參要么都在同一行,要么都各自一行
BinPackParameters: false
# 大括號換行,只有當(dāng)BreakBeforeBraces設(shè)置為Custom時(shí)才有效
BraceWrapping:
# class定義后面
AfterClass: false
# 控制語句后面
AfterControlStatement: false
# enum定義后面
AfterEnum: false
# 函數(shù)定義后面
AfterFunction: true
# 命名空間定義后面
AfterNamespace: false
# ObjC定義后面
AfterObjCDeclaration: false
# struct定義后面
AfterStruct: true
# union定義后面
AfterUnion: true
AfterExternBlock: false
# catch之前
BeforeCatch: true
# else之前
BeforeElse: true
# 縮進(jìn)大括號
IndentBraces: false
SplitEmptyFunction: true
SplitEmptyRecord: true
SplitEmptyNamespace: true
# 在二元運(yùn)算符前換行: None(在操作符后換行), NonAssignment(在非賦值的操作符前換行), All(在操作符前換行)
BreakBeforeBinaryOperators: None
# 在大括號前換行: Attach(始終將大括號附加到周圍的上下文), Linux(除函數(shù)、命名空間和類定義,與Attach類似),
# Mozilla(除枚舉、函數(shù)、記錄定義,與Attach類似), Stroustrup(除函數(shù)定義、catch、else,與Attach類似),
# Allman(總是在大括號前換行), GNU(總是在大括號前換行,并對于控制語句的大括號增加額外的縮進(jìn)), WebKit(在函數(shù)前換行), Custom
# 注:這里認(rèn)為語句塊也屬于函數(shù)
BreakBeforeBraces: Custom
# 在三元運(yùn)算符前換行
BreakBeforeTernaryOperators: false
# 在構(gòu)造函數(shù)的初始化列表的逗號前換行
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
# 每行字符的限制,0表示沒有限制
ColumnLimit: 80
# 描述具有特殊意義的注釋的正則表達(dá)式,它不應(yīng)該被分割為多行或以其它方式改變
CommentPragmas: '^ IWYU pragma:'
CompactNamespaces: false
# 構(gòu)造函數(shù)的初始化列表要么都在同一行,要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 構(gòu)造函數(shù)的初始化列表的縮進(jìn)寬度
ConstructorInitializerIndentWidth: 4
# 延續(xù)的行的縮進(jìn)寬度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的大括號{后和}前的空格
Cpp11BracedListStyle: true
# 繼承最常用的指針和引用的對齊方式
DerivePointerAlignment: false
# 關(guān)閉格式化
DisableFormat: false
# 自動(dòng)檢測函數(shù)的調(diào)用和定義是否被格式為每行一個(gè)參數(shù)(Experimental)
ExperimentalAutoDetectBinPacking: false
# 需要被解讀為foreach循環(huán)而不是函數(shù)調(diào)用的宏
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
# 對#include進(jìn)行排序,匹配了某正則表達(dá)式的#include擁有對應(yīng)的優(yōu)先級,匹配不到的則默認(rèn)優(yōu)先級為INT_MAX(優(yōu)先級越小排序越靠前),
# 可以定義負(fù)數(shù)優(yōu)先級從而保證某些#include永遠(yuǎn)在最前面
IncludeCategories:
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
Priority: 2
- Regex: '^(<|"(gtest|isl|json)/)'
Priority: 3
- Regex: '.*'
Priority: 1
# 縮進(jìn)case標(biāo)簽
IndentCaseLabels: true
IndentPPDirectives: AfterHash
# 縮進(jìn)寬度
IndentWidth: 4
# 函數(shù)返回類型換行時(shí),縮進(jìn)函數(shù)聲明或函數(shù)定義的函數(shù)名
IndentWrappedFunctionNames: false
# 保留在塊開始處的空行
KeepEmptyLinesAtTheStartOfBlocks: false
# 開始一個(gè)塊的宏的正則表達(dá)式
MacroBlockBegin: ''
# 結(jié)束一個(gè)塊的宏的正則表達(dá)式
MacroBlockEnd: ''
# 連續(xù)空行的最大數(shù)量
MaxEmptyLinesToKeep: 1
# 命名空間的縮進(jìn): None, Inner(縮進(jìn)嵌套的命名空間中的內(nèi)容), All
NamespaceIndentation: Inner
# 使用ObjC塊時(shí)縮進(jìn)寬度
ObjCBlockIndentWidth: 4
# 在ObjC的@property后添加一個(gè)空格
ObjCSpaceAfterProperty: false
# 在ObjC的protocol列表前添加一個(gè)空格
ObjCSpaceBeforeProtocolList: true
# 在call(后對函數(shù)調(diào)用換行的penalty
PenaltyBreakBeforeFirstCallParameter: 19
# 在一個(gè)注釋中引入換行的penalty
PenaltyBreakComment: 300
# 第一次在<<前換行的penalty
PenaltyBreakFirstLessLess: 120
# 在一個(gè)字符串字面量中引入換行的penalty
PenaltyBreakString: 1000
# 對于每個(gè)在行字符數(shù)限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 將函數(shù)的返回類型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine: 60
# 指針和引用的對齊: Left, Right, Middle
PointerAlignment: Left
# 允許重新排版注釋
ReflowComments: true
# 允許排序#include
SortIncludes: true
# 在C風(fēng)格類型轉(zhuǎn)換后添加空格
SpaceAfterCStyleCast: false
SpaceAfterTemplateKeyword: true
# 在賦值運(yùn)算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 開圓括號之前添加一個(gè)空格: Never, ControlStatements, Always
SpaceBeforeParens: ControlStatements
# 在空的圓括號中添加空格
SpaceInEmptyParentheses: false
# 在尾隨的評論前添加的空格數(shù)(只適用于//)
SpacesBeforeTrailingComments: 2
# 在尖括號的<后和>前添加空格
SpacesInAngles: false
# 在容器(ObjC和JavaScript的數(shù)組和字典等)字面量中添加空格
SpacesInContainerLiterals: false
# 在C風(fēng)格類型轉(zhuǎn)換的括號中添加空格
SpacesInCStyleCastParentheses: false
# 在圓括號的(后和)前添加空格
SpacesInParentheses: false
# 在方括號的[后和]前添加空格,lamda表達(dá)式和未指明大小的數(shù)組的聲明不受影響
SpacesInSquareBrackets: false
# 標(biāo)準(zhǔn): Cpp03, Cpp11, Auto
Standard: Cpp11
# tab寬度
TabWidth: 4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
快捷鍵
shift+alt+f 文檔格式化
ctrl+k ctrl+f 選擇快注釋
參考鏈接
Clang-Format格式化選項(xiàng)介紹
C/C++ for Visual Studio Code
ClangFormat
————————————————
版權(quán)聲明:本文為CSDN博主「core571」的原創(chuàng)文章,遵循 CC 4.0 BY-SA 版權(quán)協(xié)議,轉(zhuǎn)載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/core571/java/article/details/82867932
總結(jié)
以上是生活随笔為你收集整理的VS Code C++ 代码格式化方法(clang-format)的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: SHA1算法原理
- 下一篇: 交互软件Axure—高保真原型