C# 編碼規範與最佳實踐：從命名慣例到異常處理的完整指南

編輯：關於C語言

前言：為何要追求「高效代碼」？

「能跑起來」只是門檻，「高效、可維護、專業」才是資深工程師的分水嶺。本文彙整業界公認的 C# 編碼規範，涵蓋命名、排版、架構設計、異常處理與註解藝術，助你從「寫代碼」進化為「造產品」。

一、命名慣例：代碼的第一語言

1. 大小寫規範

PascalCase：所有單字首字母大寫。適用於：類別、介面、方法、屬性、事件、命名空間。
camelCase：首單字小寫，後續單字首字母大寫。適用於：區域變數、方法參數、私有欄位。

2. 具體命名規則

元素	慣例	範例
類別/結構/介面	PascalCase，名詞或名詞片語	`Customer`, `IComparable`
方法	PascalCase，動詞或動詞片語	`CalculateTotal()`, `SaveChanges()`
屬性/公開欄位	PascalCase，名詞/形容詞	`FirstName`, `IsActive`
區域變數/參數	camelCase，語意清晰	`totalCount`, `userName`
常數	PascalCase（公開）或 UPPER_SNAKE_CASE（私有）	`MaxRetryCount`, `DEFAULT_TIMEOUT`

3. 禁忌清單

❌ 匈牙利命名法（m_strName, nAge）
❌ 縮寫（nam, addr, sal）
❌ 單字母變數（除迴圈計數器 i, j 外）
❌ 下劃線 _ 分隔單字

二、排版與結構：視覺秩序即邏輯秩序

1. 縮進與空白

使用 Tab 縮進（非空格），保持團隊一致。
運算子、括號、逗號前後各保留一空格：if (x == y) { ... }。
大括號 {} 獨佔一行（K&R 風格或 Allman 風格二擇一，團隊統一即可）。

2. 方法與類別組織

單一檔案 300-400 行 內，超過即拆分類別。
單一方法 1-25 行，超過 25 行強制重構拆分。
方法之間保留 一個空行，邏輯區塊內部適當留白。
方法名須「見名知意」：SavePhoneNumber() 優於 SaveData() + 註解。

3. 單一職責原則（SRP）落地

// ❌ 違反 SRP：一個方法做兩件事
void SaveAddress(string address, string email) {
    SaveToDatabase(address);
    SendEmail(email);
}

// ✅ 拆分為兩個單一職責方法
void SaveAddress(string address) { /* ... */ }
void NotifySupervisor(string email) { /* ... */ }

三、型別與資源管理

優先使用 C# 關鍵字別名：int 而非 Int32，string 而非 String，object 而非 Object。
拒絕 Magic Numbers：改用 const 或 enum。
字串常數外部化至資源檔，支援多語系與免重編修改。
欄位預設 private，對外暴露屬性；避免跨方法共享成員變數，改用區域變數 + 參數傳遞。
路徑處理：絕不硬編碼 C:\，使用相對路徑、Path.Combine、AppDomain.CurrentDomain.BaseDirectory。

四、錯誤處理與使用者體驗

1. 異常處理鐵律

❌ 吞噬異常：catch (Exception) { return null; } —— 這會掩蓋 Bug。
✅ 精準捕捉：catch (FileNotFoundException ex)。
✅ 記錄完整堆疊：時間、類別、方法、參數、堆疊追蹤。
✅ 使用者訊息「具體 + 可行動」：
"更新資料庫失敗。請確認登入帳號密碼是否正確。" 而非 "錯誤發生"。
應用程式層級（AppDomain.UnhandledException、TaskScheduler.UnobservedTaskException）統一捕捉未處理異常，記錄日誌後友善提示並決定是否關閉。
try-catch 區塊越小越好，精準包裹可能拋出異常的單一操作。