Clang-Format在 Mac上的安裝與使用

Clang-Format Mac使用手冊(cè)

安裝

  1. 訪問(wèn)LLVM下載頁(yè)
  2. 下載Pre-Built Binaries中macOS版本的tar-xz文件，大小312M，注：點(diǎn)擊macOS而不是后面的(.sig)
  3. 解壓
  4. 把解壓文件夾中bin目錄下的clang-format文件復(fù)制到usr/local/bin文件夾里,sudo mv (解壓之后的路徑)/bin/clang-format /usr/local/bin/clang-format
  5. 測(cè)試是否成功 clang-format —help

也可以通過(guò)以下命令腳本來(lái)安裝LLVM 8.0.0版本

rm -rf ./clang-format/ && mkdir -p ./clang-format
curl 'http://releases.llvm.org/8.0.0/clang+llvm-8.0.0-x86_64-apple-darwin.tar.xz' -o './clang-format/clang-format.tar.xz'
tar xvfJ clang-format/clang-format.tar.xz -C ./clang-format
rm -f /usr/local/bin/clang-format
sudo mv $(pwd)/$(find clang-format | grep bin/clang-format$) /usr/local/bin/clang-format
clang-format --help

可能出現(xiàn)的問(wèn)題

clang-format, bash 命令未找到。

需要修改bash_profile文件，添加運(yùn)行路徑。具體為vim ~/.bash_profile, 在文件內(nèi)添加clang-format存放路徑，保存后退出。 source ~/.bash_profile

使用步驟

1.生成配置文件 .clang-format

//生成基于 LLVM 的配置文件
clang-format -style=LLVM -dump-config > .clang-format
//-style=LLVM|Google|Chromium|Mozilla|Webkit

2.修改配置文件

一般而言需要修改縮進(jìn)行數(shù)，每行最大字?jǐn)?shù)等

3. 將其配置文件放入待修改文件平級(jí)或上級(jí)文件夾內(nèi)，通過(guò)命令行來(lái)進(jìn)行格式化

clang-format -i <filename> -style=file
//-i表示直接在源文件內(nèi)進(jìn)行修改，不加則將修改后的文件內(nèi)容輸出到終端。
//<filename> 替換為文件路徑

注意：

  1. clang-format 不支持多文件處理，如果需要的話需要寫(xiě)腳本來(lái)執(zhí)行，例如:
#!/bin/sh
for file in `find . -name '*.[mh]'`
do
    clang-format -i $file -style=file
done
  1. clang-format對(duì)宏支持不夠友好，如果在宏內(nèi)已經(jīng)寫(xiě)了分號(hào)，調(diào)用宏時(shí)如果不加分號(hào)會(huì)與下一行進(jìn)行合并。

附錄

1. Clang-format 選項(xiàng)說(shuō)明

---
# 語(yǔ)言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language:   Cpp
# BasedOnStyle: LLVM
# 訪問(wèn)說(shuō)明符(public、private等)的偏移
AccessModifierOffset:   -4
# 開(kāi)括號(hào)(開(kāi)圓括號(hào)、開(kāi)尖括號(hào)、開(kāi)方括號(hào))后的對(duì)齊: Align, DontAlign, AlwaysBreak(總是在開(kāi)括號(hào)后換行)
AlignAfterOpenBracket:  Align
# 連續(xù)賦值時(shí)，對(duì)齊所有等號(hào)
AlignConsecutiveAssignments:    true
# 連續(xù)聲明時(shí)，對(duì)齊所有聲明的變量名
AlignConsecutiveDeclarations:   true
# 左對(duì)齊逃脫換行(使用反斜杠換行)的反斜杠
AlignEscapedNewlinesLeft:   true
# 水平對(duì)齊二元和三元表達(dá)式的操作數(shù)
AlignOperands:  true
# 對(duì)齊連續(xù)的尾隨的注釋
AlignTrailingComments:  true
# 允許函數(shù)聲明的所有參數(shù)在放在下一行
AllowAllParametersOfDeclarationOnNextLine:  true
# 允許短的塊放在同一行
AllowShortBlocksOnASingleLine:  false
# 允許短的case標(biāo)簽放在同一行
AllowShortCaseLabelsOnASingleLine:  false
# 允許短的函數(shù)放在同一行: None, InlineOnly(定義在類(lèi)中), Empty(空函數(shù)), Inline(定義在類(lèi)中，空函數(shù)), All
AllowShortFunctionsOnASingleLine:   Empty
# 允許短的if語(yǔ)句保持在同一行
AllowShortIfStatementsOnASingleLine:    false
# 允許短的循環(huán)保持在同一行
AllowShortLoopsOnASingleLine:   false
# 總是在定義返回類(lèi)型后換行(deprecated)
AlwaysBreakAfterDefinitionReturnType:   None
# 總是在返回類(lèi)型后換行: None, All, TopLevel(頂級(jí)函數(shù)，不包括在類(lèi)中的函數(shù)), 
#   AllDefinitions(所有的定義，不包括聲明), TopLevelDefinitions(所有的頂級(jí)函數(shù)的定義)
AlwaysBreakAfterReturnType: None
# 總是在多行string字面量前換行
AlwaysBreakBeforeMultilineStrings:  false
# 總是在template聲明后換行
AlwaysBreakTemplateDeclarations:    false
# false表示函數(shù)實(shí)參要么都在同一行，要么都各自一行
BinPackArguments:   true
# false表示所有形參要么都在同一行，要么都各自一行
BinPackParameters:  true
# 大括號(hào)換行，只有當(dāng)BreakBeforeBraces設(shè)置為Custom時(shí)才有效
BraceWrapping:   
  # class定義后面
  AfterClass:   false
  # 控制語(yǔ)句后面
  AfterControlStatement:    false
  # enum定義后面
  AfterEnum:    false
  # 函數(shù)定義后面
  AfterFunction:    false
  # 命名空間定義后面
  AfterNamespace:   false
  # ObjC定義后面
  AfterObjCDeclaration: false
  # struct定義后面
  AfterStruct:  false
  # union定義后面
  AfterUnion:   false
  # catch之前
  BeforeCatch:  true
  # else之前
  BeforeElse:   true
  # 縮進(jìn)大括號(hào)
  IndentBraces: false
# 在二元運(yùn)算符前換行: None(在操作符后換行), NonAssignment(在非賦值的操作符前換行), All(在操作符前換行)
BreakBeforeBinaryOperators: NonAssignment
# 在大括號(hào)前換行: Attach(始終將大括號(hào)附加到周?chē)纳舷挛?, Linux(除函數(shù)、命名空間和類(lèi)定義，與Attach類(lèi)似), 
#   Mozilla(除枚舉、函數(shù)、記錄定義，與Attach類(lèi)似), Stroustrup(除函數(shù)定義、catch、else，與Attach類(lèi)似), 
#   Allman(總是在大括號(hào)前換行), GNU(總是在大括號(hào)前換行，并對(duì)于控制語(yǔ)句的大括號(hào)增加額外的縮進(jìn)), WebKit(在函數(shù)前換行), Custom
#   注：這里認(rèn)為語(yǔ)句塊也屬于函數(shù)
BreakBeforeBraces:  Custom
# 在三元運(yùn)算符前換行
BreakBeforeTernaryOperators:    true
# 在構(gòu)造函數(shù)的初始化列表的逗號(hào)前換行
BreakConstructorInitializersBeforeComma:    false
# 每行字符的限制，0表示沒(méi)有限制
ColumnLimit:    200
# 描述具有特殊意義的注釋的正則表達(dá)式，它不應(yīng)該被分割為多行或以其它方式改變
CommentPragmas: '^ IWYU pragma:'
# 構(gòu)造函數(shù)的初始化列表要么都在同一行，要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 構(gòu)造函數(shù)的初始化列表的縮進(jìn)寬度
ConstructorInitializerIndentWidth:  4
# 延續(xù)的行的縮進(jìn)寬度
ContinuationIndentWidth:    4
# 去除C++11的列表初始化的大括號(hào){后和}前的空格
Cpp11BracedListStyle:   false
# 繼承最常用的指針和引用的對(duì)齊方式
DerivePointerAlignment: false
# 關(guān)閉格式化
DisableFormat:  false
# 自動(dòng)檢測(cè)函數(shù)的調(diào)用和定義是否被格式為每行一個(gè)參數(shù)(Experimental)
ExperimentalAutoDetectBinPacking:   false
# 需要被解讀為foreach循環(huán)而不是函數(shù)調(diào)用的宏
ForEachMacros:  [ foreach, Q_FOREACH, BOOST_FOREACH ]
# 對(duì)#include進(jìn)行排序，匹配了某正則表達(dá)式的#include擁有對(duì)應(yīng)的優(yōu)先級(jí)，匹配不到的則默認(rèn)優(yōu)先級(jí)為INT_MAX(優(yōu)先級(jí)越小排序越靠前)，
#   可以定義負(fù)數(shù)優(yōu)先級(jí)從而保證某些#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:   false
# 縮進(jìn)寬度
IndentWidth:    4
# 函數(shù)返回類(lèi)型換行時(shí)，縮進(jìn)函數(shù)聲明或函數(shù)定義的函數(shù)名
IndentWrappedFunctionNames: false
# 保留在塊開(kāi)始處的空行
KeepEmptyLinesAtTheStartOfBlocks:   true
# 開(kāi)始一個(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(后對(duì)函數(shù)調(diào)用換行的penalty
PenaltyBreakBeforeFirstCallParameter:   19
# 在一個(gè)注釋中引入換行的penalty
PenaltyBreakComment:    300
# 第一次在<<前換行的penalty
PenaltyBreakFirstLessLess:  120
# 在一個(gè)字符串字面量中引入換行的penalty
PenaltyBreakString: 1000
# 對(duì)于每個(gè)在行字符數(shù)限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 將函數(shù)的返回類(lèi)型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:  60
# 指針和引用的對(duì)齊: Left, Right, Middle
PointerAlignment:   Left
# 允許重新排版注釋
ReflowComments: true
# 允許排序#include
SortIncludes:   true
# 在C風(fēng)格類(lèi)型轉(zhuǎn)換后添加空格
SpaceAfterCStyleCast:   false
# 在賦值運(yùn)算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 開(kāi)圓括號(hào)之前添加一個(gè)空格: Never, ControlStatements, Always
SpaceBeforeParens:  ControlStatements
# 在空的圓括號(hào)中添加空格
SpaceInEmptyParentheses:    false
# 在尾隨的評(píng)論前添加的空格數(shù)(只適用于//)
SpacesBeforeTrailingComments:   2
# 在尖括號(hào)的<后和>前添加空格
SpacesInAngles: true
# 在容器(ObjC和JavaScript的數(shù)組和字典等)字面量中添加空格
SpacesInContainerLiterals:  true
# 在C風(fēng)格類(lèi)型轉(zhuǎn)換的括號(hào)中添加空格
SpacesInCStyleCastParentheses:  true
# 在圓括號(hào)的(后和)前添加空格
SpacesInParentheses:    true
# 在方括號(hào)的[后和]前添加空格，lamda表達(dá)式和未指明大小的數(shù)組的聲明不受影響
SpacesInSquareBrackets: true
# 標(biāo)準(zhǔn): Cpp03, Cpp11, Auto
Standard:   Cpp11
# tab寬度
TabWidth:   4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
...

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容