clang-format的介紹和使用

目錄

參考資訊

介紹

OVERVIEW: A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code.

Clang-Format可用于格式化（排版）多種不同語言的程式碼。
其自帶的排版格式主要有：LLVM, Google, Chromium, Mozilla, WebKit等

若-style=google ，則表示應用Google的格式化風格

安裝

請看官網上的安裝方式，或者Google一下你的OS安裝方式吧。

這裡給出我常用OS安裝方式：
macOS10.14.6 brew install clang-format
ubuntu18.04 sudo apt install clang-format

命令格式

USAGE: clang-format [options] [<file> ...]

clang-format --help 建議至少瀏覽一遍幫助資訊。

基本使用

// 以LLVM程式碼風格格式化main.cpp, 結果輸出到stdout
clang-format -style=LLVM main.cpp
// 以LLVM程式碼風格格式化main.cpp, 結果直接寫到main.cpp
clang-format -style=LLVM -i main.cpp
// 當然也支援對指定行格式化，格式化main.cpp的第1，2行
clang-format -lines=1:2 main.cpp

使用.clang-format來實現自定義格式化

導出.clang-format文件

When the desired code formatting style is different from the available options, the style can be customized using the -style="{key: value, ...}" option or by putting your style configuration in the .clang-format or _clang-format file in your project』s directory and using clang-format -style=file.

An easy way to create the .clang-format file is:

clang-format -style=可選格式名 -dump-config > .clang-format
# 可選格式最好寫預設那那幾個寫最接近你想要的格式. 比如我想要接近google C++ style的。 我就寫-style=google

看了官網的介紹，我們知道我們可以使用.clang-format 文件來自定義格式。在使用時不再是-style=llvm等內置可選的那幾種的格式。
使用我們自定義.clang-formart文件來格式化。指定方式為-style=file

注意：一般取.clang-format或_clang-format，因為自定義的排版格式文件只有取這兩種名字之一，才能被Clang-Format識別。

現在對生成的.clang-format文件根據自己需求進行修改吧

使用.clang-format文件

直接將修改後的文件放在和程式碼文件相同的文件夾中，並且設置格式化選項-style=file，即可以使用自定義的排版格式。
VS Code只要將該文件放在和程式碼文件相同的文件夾中即可，不需要額外的設置。
格式化文件放在程式碼文件的上一級文件夾中，也可以使用。(個人建議放在項目的根目錄下。我看不少開源項目就是這麼乾的，嘿嘿嘿)
注意，文件名必須為.clang-format或_clang-format。

# 格式化的結果打到stdout(終端上)
clang-format -style=file main.cc
# 直接修改到文件
clang-format -style=file -i main.cc

.clang-format配置文件的各個選項的含義

---
# 語言: 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
# 左對齊逃脫換行(使用反斜杠換行)的反斜杠
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:	false
  # 控制語句後面
  AfterControlStatement:	false
  # enum定義後面
  AfterEnum:	false
  # 函數定義後面
  AfterFunction:	false
  # 命名空間定義後面
  AfterNamespace:	false
  # ObjC定義後面
  AfterObjCDeclaration:	false
  # struct定義後面
  AfterStruct:	false
  # union定義後面
  AfterUnion:	false
  # catch之前
  BeforeCatch:	true
  # else之前
  BeforeElse:	true
  # 縮進大括弧
  IndentBraces:	false
# 在二元運算符前換行: 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:	200
# 描述具有特殊意義的注釋的正則表達式，它不應該被分割為多行或以其它方式改變
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:	false
# 縮進寬度
IndentWidth:	4
# 函數返回類型換行時，縮進函數聲明或函數定義的函數名
IndentWrappedFunctionNames:	false
# 保留在塊開始處的空行
KeepEmptyLinesAtTheStartOfBlocks:	true
# 開始一個塊的宏的正則表達式
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
# 在賦值運算符之前添加空格
SpaceBeforeAssignmentOperators:	true
# 開圓括弧之前添加一個空格: Never, ControlStatements, Always
SpaceBeforeParens:	ControlStatements
# 在空的圓括弧中添加空格
SpaceInEmptyParentheses:	false
# 在尾隨的評論前添加的空格數(只適用於//)
SpacesBeforeTrailingComments:	2
# 在尖括弧的<後和>前添加空格
SpacesInAngles:	true
# 在容器(ObjC和JavaScript的數組和字典等)字面量中添加空格
SpacesInContainerLiterals:	true
# 在C風格類型轉換的括弧中添加空格
SpacesInCStyleCastParentheses:	true
# 在圓括弧的(後和)前添加空格
SpacesInParentheses:	true
# 在方括弧的[後和]前添加空格，lamda表達式和未指明大小的數組的聲明不受影響
SpacesInSquareBrackets:	true
# 標準: Cpp03, Cpp11, Auto
Standard:	Cpp11
# tab寬度
TabWidth:	4
# 使用tab字元: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab:	Never
...

集成到vim中(官方給出了各種IDE或編輯器集成方式)

詳細看官方網站

常用命令

find . -regex '.*\.\(cpp\|hpp\|cu\|c\|h\)' -exec clang-format -style=file -i {} \;

clang-format-diff.py腳本

clang-format還提供一個clang-format-diff.py腳本，用來格式化patch，code review提交程式碼前，
可以先跑一下這個腳本，看有沒有問題。

// 格式化最新的commit，並直接在原文件上修改
git diff -U0 HEAD^ | clang-format-diff.py -i -p1

官網寫了 git svn Mercurial/hg 的使用，詳細請到官網看吧

Tags:

VirMach 便宜 VPS

QNews

QNews