C/C++ clang-format 對程式碼風格排版格式化

在大型專案裡多人一起開發, 程式碼的 coding sytle 統一是個值得討論的議題,
統一 coding sytle 有下列好處:

  • 提昇 code 閱讀速度
  • 規則明確, 無須多花費時間

以下介紹一個 c/c++ coding sytle 統一的好工具, clang-format

安裝方法

1
sudo apt-get install clang-format

clang-format 對程式碼排版格式化

輸入以下指令就會將 main.cpp 進行風格統一

1
clang-format -i main.cpp

git 指令對程式碼排版格式化

如果我只想針對我的修改部分做clang-format要怎麼做?

首先先將更動的檔案git add加入stage,
再使用git clang-format就會對stage裡檔案的修改部分進行clang-format重新排版。

1
2
3
git add <file>
...
git clang-format

Visual Studio Code 對程式碼排版格式化

VS Code 要先裝clang-format擴充套件才能夠對程式碼clang-format排版格式化,
格式化原始碼的快捷鍵為:
Ctrl + Shift + f (Windows)
Ctrl + Shift + i (Linux)
Option + Shift + f (MacOS)
也可以按右鍵選擇 Format Document。

.clang-format 程式碼風格設定檔

如果目錄下有.clang-format檔會以這個檔裡設定值為主。

其他參考
使用 clang-format 對程式碼進行排版
https://hsins.me/blog/2019/05/27/format-source-code-with-clang-format/

其它相關文章推薦
C/C++ 新手入門教學懶人包
Visual Studio Code 常用快捷鍵