1. 程式人生 > >Xcode程式碼格式化外掛教程與配置

Xcode程式碼格式化外掛教程與配置

前言

統一團隊內部程式設計風格,提高程式的可讀性以及團隊的編碼效率,避免團隊在開發過程中因為編碼風格的差異可能帶來的混亂,所以說程式碼規範對於團隊的好處想必大家應該都知道。簡書文章地址

正文

ClangFormat-Xcode:是一款Xcode的程式碼格式化外掛 (github下載連結),非常方便好用,可以極大減少花費調整程式碼規範的時間,提高編碼效率。用了之後,媽媽再也用不擔心我的編碼規範了。
下面教大家怎麼去配置ClangFormat-Xcode,打造一個屬於自己的團隊的程式碼規範。

安裝外掛

  • 1.手動安裝
    和其他的外掛一樣,先去github下載工程,執行程程式安裝。
  • 2.自動安裝
    如果安裝過Alcatraz的同學,可以去視覺化視窗搜尋ClangFormat,點選Install自動安裝。

配置引數

安裝完成之後重啟Xcode,點選Load Bundle,選擇Xcode ->Edit,看到ClangFormat的選項,說明安裝成功了。

ClangFormat選單
我們可以看到有LLVM,Google,Chromium,Mozilla,WebKit,File這幾種格式化風格,File就是我們自定義的風格。
下面我來教大家怎麼去自定義風格。
首先建立一個.clang-format檔案,建立這個檔案有兩種方式:
* 1.終端建立:這邊以DemoTest專案為例,開啟終端,cd到工程目錄

下(一定要工程目錄哦),建立一個.clang-format檔案。
截圖

  $  cd /Users/xxxx/AppGo
  $  vim .clang-format

然後將下面這些配置引數貼上進去,這些引數是我根據我們團隊的程式碼規範整理出來的(僅供參考),可能並不適合你們的團隊,所有引數的含義下面都有說明:

# 基礎樣式
BasedOnStyle: LLVM

# 縮排寬度
IndentWidth: 4

# 花括號的換行方式(Attach,Stroustrup, Allman-所有大括號都另起一行)
BreakBeforeBraces: Allman

# 支援一行的if
AllowShortIfStatementsOnASingleLine: false
# 是否允許迴圈單行 AllowShortLoopsOnASingleLine: false # switch的case縮排 IndentCaseLabels: true # 針對OC的block的縮排寬度 ObjCBlockIndentWidth: 4 # 針對OC,屬性名後加空格 ObjCSpaceAfterProperty: true # 每行字元的寬度限制,0不限制 ColumnLimit: 0 # 註釋對齊 AlignTrailingComments: true # 括號後加空格 SpaceAfterCStyleCast: true # 不在小括號里加空格 SpacesInParentheses: false # 不在中括號里加空格 SpacesInSquareBrackets: false # 指標對準 # DerivePointerAlignment: true # @[]裡面兩邊空格,預設true SpacesInContainerLiterals: false # 賦值前(=)的空格 預設true #SpaceBeforeAssignmentOperators: true # 指標的位置 PointerAlignment: Right # 最大空的行數 MaxEmptyLinesToKeep: 1
  • 2.手動拖入:如果你覺得上面太麻煩,你也可以用比較簡單粗暴的方法,把配置好的.clang-format檔案直接拖到工程目錄下,這邊附上配置好的.clang-format

基本使用

前面的配置成功之後,後面的使用就更簡單了,開啟你剛剛配置的工程,然後點選Xcode ->Edit->ClangFormat->Format Select Files,格式化整個檔案中的程式碼。
下面附上兩張格式化前和格式化後的截圖:

格式化前

格式化後


是不是感覺一下子從鳳姐變成了AngelaBaby,程式碼是我們程式設計師的臉面,大家理應重視。

快捷鍵

快捷鍵的使用:可以給常用的操作設定快捷鍵,我們一般常用的操作是Format Select Files和Format Select Text兩個功能。
* 1.Format Select Files是格式化當前檔案的程式碼。設定快捷鍵:點選下面的Enable Format on Save(當它是Disable Format on Save狀態就不用點了),外掛會自動幫我們生成(Command+S)快捷鍵。


  • 2.Format Select Text是格式化選中的程式碼。這個快捷鍵需要手動設定。

(PS:第二個快捷鍵可以不用設定的,因為Format Select Files格式化當前檔案已經夠用了,感興趣的同學可以試試),開啟設定->鍵盤->快捷鍵->點選右側應用快捷鍵->新增。

ok,大功告成

最後

文中如果有錯誤的地方,還請大神指正。
附上文中配置好的.clang-format已經上傳GitHub(我們團隊的,僅供參考)。
如果你看完後覺得對你有所幫助,還望在GitHub上點個star。贈人玫瑰,手有餘香。