clangformat——代碼規範的最好夥伴

一、clangformat配置

clangformat是來自於LLVM開發團隊的一個基於clang的代碼格式化工具，用於統一代碼的風格，使代碼具備良好的可讀性和可維護性。

使用clangformat之前，需要進行配置，配置文件一般命名為「.clang-format」，位於項目根目錄或用戶目錄下。下面是一份針對C++項目的配置文件示例：

BasedOnStyle: Google # 使用Google代碼風格為基準進行配置
IndentWidth: 4 # 縮進寬度為4個空格
AccessModifierOffset: -4 # private, protected, public之間的縮進
KeepEmptyLinesAtTheStartOfBlocks: false # 塊開始處不保留空行
KeepEmptyLinesAtTheEndOfBlocks: false # 塊結尾處不保留空行
AllowShortIfStatementsOnASingleLine: true # 允許if語句在一行顯示
BreakBeforeBinaryOperators: All # 所有二元運算符前都添加換行符
PointerAlignment: Left # 指針與類型左對齊
AlignTrailingComments: true # 對齊注釋

clangformat支持多種代碼風格，只需要將「BasedOnStyle」設置成相應的代碼風格名即可。常用的代碼風格還包括Google、Chromium、LLVM等。

二、clangformat vs

與其他的代碼格式化工具相比，clangformat具備以下的優勢：

1. 完全免費

clangformat是開源的，完全免費，用戶可以自由地使用、修改、分享、發布它。

2. 配置靈活

在配置文件中，用戶可以針對自己的項目和個人習慣，對代碼格式化進行靈活的配置。

3. 支持多個編程語言

clangformat不僅支持C++代碼的格式化，還支持其他的編程語言，包括C、Objective-C、Java等。

三、clangformat下載

clangformat本身是作為clang的一部分打包發布的，因此只需要下載、安裝clang即可使用clangformat。

在Linux系統中，可以通過以下命令進行安裝：

sudo apt-get install clang

在Windows系統中，可以從以下網址下載clang的Windows版本：

https://releases.llvm.org/download.html

四、clangformat自定義

如果配置文件中沒有涵蓋到需求，用戶可以使用clangformat提供的命令行選項、環境變數或API進行定製化。下面是一些重要的選項：

1. -style

通過該選項指定代碼風格名，可以覆蓋配置文件中的設置：

clang-format -style=Google -i some_file.cpp

2. -assume-filename

當clangformat無法確定目標文件的類型時，可以使用該選項指定文件類型：

clang-format -style=Google -assume-filename=sample.h -i some_file

3. -dump-config

該選項會輸出clangformat的完整配置，包括默認設置和用戶自定義設置：

clang-format -style=Google -dump-config > .clang-format

五、clangformat qt

Qt是C++程序開發中的一個流行框架，clangformat也已經為Qt提供了專門的配置文件。下面是一份基於Qt的配置文件示例：

# .clang-format file for Qt projects
BasedOnStyle: Qt
IndentWidth: 4
TabWidth: 4
UseTab: Never
AlignTrailingComments: true
BreakBeforeBraces: Allman
AllowShortIfStatementsOnASingleLine: true

六、clangformat 頭文件

頭文件也是代碼中不可或缺的一部分，clangformat提供了選項來配置頭文件的排列。下面是一份頭文件排列的配置文件示例：

BasedOnStyle: Google
SortIncludes: true
IncludeCategories:
  - Regex: '^"(llvm|clang|gtest|gmock|sqlite3|Catch).h"'
    Priority: 2
  - Regex: '^(<|"(gtest|gmock)/)'
    Priority: 3
  - Regex: '^"'
    Priority: 1
  - Regex: '.*'
    Priority: 4
    

上述配置文件中，頭文件被分為四個類別，Priority的值越小，優先順序越高。正則表達式用於匹配不同的頭文件。

上述代碼示例均為參考示例，具體的配置文件需要根據實際項目需要進行調整。