2. 程式人生 > 實用技巧 >clang-format的介紹和使用

clang-format的介紹和使用

阿新 • • 發佈：2020-07-16

目錄

參考資訊

介紹

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 的使用，詳細請到官網看吧

相關推薦

clang-format的介紹和使用

目錄 參考資訊 介紹 安裝 命令格式 基本使用 使用.clang-format來實現自定義格式化 匯出.clang-format檔案

SQLite的簡單介紹和使用場景

什麼是SQLite? SQLite是一款輕型的嵌入式資料庫.它的資料庫就是一個檔案. 小型嵌入式,跟mysql差不多,但是更小,功能相對較少,它佔用的資源非常低,可能只需要幾百k的記憶體就夠了.

Go排程器介紹和容易忽視的問題

本文記錄了本人對Golang排程器的理解和跟蹤排程器的方法，特別是一個容易忽略的goroutine執行順序問題，看了很多篇Golang排程器的文章都沒提到這個點，分享出來一起學習，歡迎交流指正。

IDEA JetBrains Mono字型介紹和安裝教程(詳解)

JetBrainsMono 是 JetBrains 公司開發的一款開源字型，可免費商用。 正如其名字帶的Mono，即Monospaced Font，它一款為開發者設計的等寬字型。

restful api介面介紹和資料返回及異常處理

什麼是介面api介面開發，其實和平時開發邏輯差不多；但是也有略微差異；MVC開發模式：平時使用mvc開發網站的思路一般是都 由控制器 去 呼叫模型，模型返回資料，再由控制器把資料放到檢視中，展現給使用者；api開發介

Docker 快速入門（一）- 情況介紹和安裝

歡迎您! 很高興您想學習 Docker 。 這個頁面包含了如何開始使用 Docker 的循序漸進的說明。

Nginx 介紹和安裝(centos7)

本文是作者原創,版權歸作者所有.若要轉載,請註明出處 什麼是 nginx ? 　　Nginx 是高效能的 HTTP 和反向代理的伺服器，處理高併發能力是十分強大的，能經受高負 載的考驗,有報告表明能支援高達 50,000 個併發連線數。

Spring RestTemplate 的介紹和使用-入門

RestTemplate是什麼？ 傳統情況下在java程式碼裡訪問restful服務，一般使用Apache的HttpClient。不過此種方法使用起來太過繁瑣。spring提供了一種簡單便捷的模板類來進行操作，這就是RestTemplate。

管道：介紹和基本服務

管道：介紹和基本服務 Pipes: introduction and basic services 與郵箱或佇列相比，它們提供了在任務之間傳遞簡單訊息的更靈活的方式。

Spring升級案例之IOC介紹和依賴注入

Spring升級案例之IOC介紹和依賴注入 一、IOC的概念和作用 1.什麼是IOC 控制反轉(Inversion of Control, IoC)是一種設計思想，在Java中就是將設計好的物件交給容器控制，而不是傳統的在物件內部直接控制。傳統Java SE

Spring升級案例之IOC介紹和依賴注入（轉載）

Spring升級案例之IOC介紹和依賴注入 一、IOC的概念和作用 1.什麼是IOC 控制反轉(Inversion of Control,IoC)是一種設計思想，在Java中就是將設計好的物件交給容器控制，而不是傳統的在物件內部直接控制。傳統Java SE程

AJAX介紹和使用

AJAX介紹和使用 部落格說明 文章所涉及的資料來自網際網路整理和個人總結，意在於個人學習和經驗彙總，如有什麼地方侵權，請聯絡本人刪除，謝謝！

Python+Selenium中級篇之2-Python中類/函式/模組的簡單介紹和方法呼叫

從本文開始陸續介紹一些中級的技能前篇文章介紹了PyCharm的基本使用，接下來我們的指令碼程式碼都在這個PyCharm這個編輯器裡寫。好處有很多，專案檔案結構層次清晰，寫程式碼的時候會自動化提示和補全。這裡，我們在

EChart和hightcharts介紹和使用（生成圖示）

有兩種生成圖表方法： 　　hightcharts（推薦）　　 https://www.highcharts.com.cn/ 　　echarts　　　　　　　 https://echarts.apache.org/examples/zh/index.html

Haystack的介紹和使用

Haystack的介紹和使用 一，什麼是Haystack 搜尋是一個日益重要的話題。使用者越來越依賴於搜尋從噪聲資訊中分離和快速找到有用資訊。此外，搜尋搜尋可以洞察那些東西是受歡迎的，改善網站上難以查詢的東西。

Java WeakReference介紹和分析

1.概述 在Java裡, 當一個物件o被建立時, 它被放在Heap裡. 當GC執行的時候, 如果發現沒有任何引用指向o, o就會被回收以騰出記憶體空間. 或者換句話說, 一個物件被回收, 必須滿足兩個條件: 1)沒有任何引用指向它 2)GC被

【運維--系統】nacos介紹和安裝

目錄： 簡介 安裝java 安裝mysql 安裝nacos 附錄 簡介 Nacos 致力於幫助您發現、配置和管理微服務。Nacos 提供了一組簡單易用的特性集，幫助您快速實現動態服務發現、服務配置、服務元資料及流量管理。

Google guava工具類的介紹和使用

今天來說說guava，以後也會講解apache common.lang下的utils使用,為什麼要講guava，因為jdk 的升級很多都是借鑑guava裡面的思想來進行的。

MSTP協議介紹和堆疊技術介紹

單生成樹的弊端 部分VLAN路徑不通  如圖所示，網路中有SWA、SWB、SWC三臺交換機。配置VLAN2通過兩條上行鏈路，配置VLAN3只通過一條上行鏈路。 為了解決VLAN2的環路問題，需要執行生成樹。在執行單個生成樹的情況

Selenium模組化驅動測試介紹和例項

線性模型介紹： 線性模型雖然每個用例都可以拿來獨立執行，但是用例之間重複程式碼多，開發、維護成本高。