cpp-template

這個專案提供一個簡單的 C++ 樣板，包含基本的目錄結構、Makefile 與開發輔助工具，方便快速開始新專案。

目錄結構

• src/: 主要的 C++ 原始碼，目前包含 main.cpp。
• build/: 由 Makefile 自動建立，用來存放編譯後的物件檔。
• utils/: 收錄常用腳本，例如編譯、執行、清理、格式化與 clang-tidy。
• .clang-format: 定義 clang-format 的專案格式規則。
• .clang-tidy: 定義 clang-tidy 的檢查設定。
• Makefile: 管理編譯、執行、清理、格式化與靜態分析等命令。

建置與執行

若系統已安裝 g++，可使用以下命令：

# 編譯 (預設目標 app)
make

# 編譯並執行
make run

# 清理 build 及執行檔
make clean

# 以 clang-format 重新排版 src/*.cpp/.hpp/.h
make format

# 以 clang-tidy 檢查所有 src/*.cpp
make tidy

# 確認並安裝 clang-format/clang-tidy（需要 apt 與可能的 sudo）
make install

# 確認 clang-format 與 clang-tidy 是否可用
make tools

如需覆寫工具或編譯器設定，可在命令前傳入變數，例如：

CLANG_FORMAT=/opt/llvm/bin/clang-format CLANG_TIDY=/opt/llvm/bin/clang-tidy make tidy
CXX=clang++ CXXFLAGS="-std=c++20 -O3" make

也可以透過 utils/ 底下的腳本快速操作：

./utils/build.sh        # 執行 make，接受額外參數
./utils/run.sh          # 編譯並執行
./utils/clean.sh        # 移除 build/ 與 app
./utils/format.sh       # 呼叫 make format，可用 CLANG_FORMAT 指定執行檔
./utils/tidy.sh         # 呼叫 make tidy，可用 CLANG_TIDY 指定執行檔

如需指定不同的目標或旗標，可直接傳入 utils/build.sh：

./utils/build.sh TARGET=my_app CXXFLAGS="-O3 -DNDEBUG"

程式碼格式化

make format 會確認 clang-format 是否可用，再對 src/ 目錄內的 .cpp/.hpp/.h 檔案進行格式化。透過 CLANG_FORMAT=/path/to/clang-format make format 或 CLANG_FORMAT=/path/to/clang-format ./utils/format.sh 可覆寫預設執行檔。專案提供的 .clang-format 以 LLVM 風格為基礎，並設定：

• C++20 標準
• 4 空格縮排，最大列寬 100
• 自訂括號換行與 namespace 縮排規則

靜態分析

.clang-tidy 啟用了一些常用的檢查（bugprone-*、clang-analyzer-*、modernize-* 等）。可使用 make tidy 或 CLANG_TIDY=/path/to/clang-tidy make tidy 對 src/*.cpp 逐一檢查；若要檢查特定檔案，可執行：

clang-tidy src/main.cpp --

可視需求調整 Checks、HeaderFilterRegex 或其他設定來符合專案需求。

工具安裝

make install 會檢查是否能找到 clang-format 與 clang-tidy。若缺少任何一項且系統支援 apt-get，會嘗試以 sudo apt-get update 與 sudo apt-get install -y 安裝所需套件（若沒有 sudo 則直接呼叫 apt-get）。若環境沒有 apt-get，指令會提示手動安裝缺少的工具。

下一步

• 在 src/ 新增更多檔案與模組。
• 依專案需求擴充 Makefile 或 utils 腳本。
• 若需要不同的編碼規範或靜態分析工具，修改 .clang-format 與 .clang-tidy 即可。