專業 C++ 開發編碼規範：可讀性、耦合度與安全性實務指南

前言

專業軟體產品的開發過程中，嚴謹的編碼規範能有效減少隱性錯誤、提升程式可維護性並強化團隊協作效率。本文整理適用於 32 位元 Windows 平台、以 C++ 為基礎語言 (VC++、標準 C++) 的實務編碼準則，涵蓋可讀性、耦合控制、基本防錯技巧三大面向。

一、提高程式可讀性要求

1. 檔案級標準化註解

每個檔案開頭須包含：用途說明、版本號、作者、建立/修改日期。

2. 類別詳細註解

包含作者、版本修訂、核心演算法、成員變數用途說明。

3. 函數完整契約註解

輸入/輸出參數、傳回值、功能描述、例外狀況、呼叫範例。

4. 函數內部分層註解

// ************* 實現下列功能 *************
// 執行...操作 (1)
.............. // 此操作作用為...
// 執行...操作 (2)

長程式區塊結尾加註：// for 迴圈結束

5. 命名規範

• 意義明確、易理解，避免縮寫造成歧義。
• 區分變數範疇：成員變數 m_*、全域變數 g_*、API 函數 ::。

6. 消除魔術數字

const static WORD W_PERSON_NUM = 10;
BOOL bMustProcess = TRUE; // 而非直接寫 TRUE/FALSE

7. 邏輯判斷寫法統一

if (TRUE == test)       // 避免誤寫成指派
if (PersonNum == test)
if (NULL != pPtr)

8. 控制結構限制

• 禁用 goto。
• 避免過長或過深巢狀的 if/for/while，建議拆分為獨立函數。

二、消除程式隱患 - 降低耦合、提高內聚

降低耦合性

1. 僅對外必要介面設為 public。
2. 成員變數一律 private/protected，提供 Get/Set 存取器。
3. 盡量不使用全域變數；必要時置於 CWinApp 衍生類，透過 AfxGetApp() 存取。

提高內聚性

1. 公用函數不回傳成員指標或非常數引用。
2. 僅透過指標/引用使用的類別，其標頭檔置於 .cpp 而非 .h，減少編譯相依。
3. 函數功能單一、參數語意單一。

三、基本防錯規則

1. 善用括號明確運算優先序。
2. 優先使用參考參數替代指標 (語意清晰、保證已初始化、效率相同)。
3. 變數定義即初始化。
4. 比較時將常數置左：NULL == pPtr、FALSE == flag (防止誤寫成指派)。
5. 空迴圈寫法：while (--n) NULL; (避免誤加分號)。
6. 常數定義用 const static 替代 #define (啟用型別檢查)。
7. 含虛擬函數的類別，解構函數必須宣告為 virtual。
8. 編譯警告等級設為 Level 4，零警告通過。
9. Debug/Release 區隔：#ifdef _DEBUG ... #endif。
10. 解除安裝時清除自訂 DLL、OCX、登錄項目。

結語

編碼規範非束縛開發者創意之枷鎖，而是團隊共同遵守的「交通規則」。持續精進規範、落實 Code Review，方能打造經得起時間考驗的優質軟體資產。