在VS Code or Keil MDK中使用clang-format格式化C_C++代碼

一、下載最新的clang-format工具

https://llvm.org/builds/

只要下載clang-fomat-xxxxxxx.exe就夠了

 

 

 

 


二、VS Code中使用

一般來說,安裝了C/C++插件就可以直接按alt+shift+f就可以格式化當前文件了,但經測試,vs code插件中的C/C++(版本0.26.0)自帶的clang-format版本不支持宏定義對齊(鍵值AlignConsecutiveMacros)),因此需要將下載到的clang-fomat-xxxxxxx.exe更名後替換安裝目錄的clang-format.exe,默認路徑如下:

 

vs code中還可以設置保存/換行/粘貼時自動格式化:設置->文本編輯器->正在格式化

 


三、VS studio中使用

VS studio默認自帶clang-format工具,因此只需要替換爲最新的即可

 


四、MDK中使用

  • 1、將clang-format放入任一目錄。
  • 2、打開keil,Tools->Customize Tools Menu,配置如下:

 

  • 3、還可設置快捷鍵:alt+shift+f
  • 4、Keil中使用時需要先保存好文件

 


五、補上最新的clang-format.exe及定義好的-clang_format配置

 

 

有關clang-format格式的說明:

http://clang.llvm.org/docs/ClangFormatStyleOptions.html

---
# 語言: 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
# 宏對齊
AlignConsecutiveMacros: 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:	true
  # 控制語句後面
  AfterControlStatement:	true
  # enum定義後面
  AfterEnum:	true
  # 函數定義後面
  AfterFunction:	true
  # 命名空間定義後面
  AfterNamespace:	true
  # ObjC定義後面
  AfterObjCDeclaration:	true
  # struct定義後面
  AfterStruct:	true
  # union定義後面
  AfterUnion:	true
  # catch之前
  BeforeCatch:	true
  # else之前
  BeforeElse:	true
  # 縮進大括號
  IndentBraces:	false
  # extern 
  AfterExternBlock: false
  # case後換行
  AfterCaseLabel: true
# 在二元運算符前換行: 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:  0 #126
# 描述具有特殊意義的註釋的正則表達式,它不應該被分割爲多行或以其它方式改變
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:	'^(<|"(gtest|isl|json)/)'
    Priority:	3
  - Regex:	'.*'
    Priority:	1
# 縮進case標籤
IndentCaseLabels:	true
# 縮進寬度
IndentWidth:	4
# 函數返回類型換行時,縮進函數聲明或函數定義的函數名
IndentWrappedFunctionNames:	false
# 保留在塊開始處的空行
KeepEmptyLinesAtTheStartOfBlocks:	true
# 開始一個塊的宏的正則表達式
MacroBlockBegin:	''
# 結束一個塊的宏的正則表達式
MacroBlockEnd:	''
# 連續空行的最大數量
MaxEmptyLinesToKeep:	10
# 命名空間的縮進: None, Inner(縮進嵌套的命名空間中的內容), All
NamespaceIndentation:	Inner
# 使用ObjC塊時縮進寬度
ObjCBlockIndentWidth:	4
# 在ObjC的@property後添加一個空格
ObjCSpaceAfterProperty:	false
# 在ObjC的protocol列表前添加一個空格
ObjCSpaceBeforeProtocolList:	true
# 在call(後對函數調用換行的penalty
PenaltyBreakBeforeFirstCallParameter:	19
# 在一個註釋中引入換行的penalty
PenaltyBreakComment:	106
# 第一次在<<前換行的penalty
PenaltyBreakFirstLessLess:	120
# 在一個字符串字面量中引入換行的penalty
PenaltyBreakString:	1000
# 對於每個在行字符數限制之外的字符的penalty
PenaltyExcessCharacter:	1000000
# 將函數的返回類型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:	60
# 指針和引用的對齊: Left, Right, Middle
PointerAlignment:	Right
# 允許重新排版註釋
ReflowComments:	true
# 允許排序#include
SortIncludes:	false
# 在C風格類型轉換後添加空格
SpaceAfterCStyleCast:	false
# 在賦值運算符之前添加空格
SpaceBeforeAssignmentOperators:	true
# 開圓括號之前添加一個空格: Never, ControlStatements, Always
SpaceBeforeParens:	Never #ControlStatements
# 在空的圓括號中添加空格
SpaceInEmptyParentheses:	false
# 在尾隨的評論前添加的空格數(只適用於//)
SpacesBeforeTrailingComments:	4
# 在尖括號的<後和>前添加空格
SpacesInAngles:	true
# 在容器(ObjC和JavaScript的數組和字典等)字面量中添加空格
SpacesInContainerLiterals:	true
# 在C風格類型轉換的括號中添加空格
SpacesInCStyleCastParentheses:	false
# 在圓括號的(後和)前添加空格
SpacesInParentheses:	false
# 在方括號的[後和]前添加空格,lamda表達式和未指明大小的數組的聲明不受影響
SpacesInSquareBrackets:	false
# 標準: Cpp03, Cpp11, Auto
Standard:	Cpp11
# tab寬度
TabWidth:	4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab:	Never

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章