C 語言編程風格指南：從排版、註釋、命名到函數規範的完整實踐

int fun() {
    int a = 0, b = 5, sum;

    sum = a + b;

    printf("Sum is %d\n", sum);
}

2. 註釋規範

程式碼分四級：
① 無需註釋（自解釋）
② 風格稍弱但註釋完善
③ 風格與註釋皆弱，靠文檔補救
④ 垃圾碼（風格、註釋、文檔俱無）

函數頭部註釋模板

/*************************************************
 Function:       // 函數名
 Description:    // 功能、效能描述
 Calls:          // 被調用函數列表
 Called By:      // 調用本函數的函數列表
 Input:          // 輸入參數說明
 Output:         // 輸出參數說明
 Return:         // 返回值說明
 Others:         // 其它說明
 *************************************************/

行內註釋原則

• 置於語句上方或右側，上方無空行。
• 物理含義的常量/變量/結構體聲明處必註。
• 全域變量詳註功能、取值範圍、存取注意事項。
• 選擇/迴圈語句註明分支/迴圈體意義。
• 右大括號旁註明匹配的起始塊：} /* end of while */。

3. 標識符命名

通用原則

• 清晰明確，少用縮寫，禁用無意義單字母（a,b,i 僅限迴圈計數器）。
• 全英文，駝峰或下劃線二選一且專案統一。

分類命名規範

4. 變數與結構使用規範

• 定義即初始化：數值型 =0，指標 =NULL。
• 極力減少全域變數，降低耦合。
• 不可變量用 const。
• 結構體功能單一、規模適中，避免巨型結構。
• 減少強制類型轉換，效能與可讀性雙損。
• 結構體成員按大小排序，減少記憶體對齊浪費。

5. 函數使用規範

• 可能失敗的函數回傳錯誤碼（宏定義預定義）。
• 純函數原則：相同輸入必得相同輸出。
• 單一職責：一個函數只做一件小事。
• 嚴格區分 in/out 參數，只讀參數加 const。
• 函數開頭驗證參數與外部資源有效性。
• 參數過多（>4）時封裝為結構體傳遞。

結語

風格無絕對標準，但團隊內必須統一。從今天開始，用「給新手讀」的標準審視每一行代碼，養成專業習慣，受益職業生涯。