Effective C# 原則 4：用條件屬性取代 #if 預處理器（上）

預處理器指令的問題

#if/#endif 可產生不同建置輸出，但濫用導致：

• 程式碼閱讀困難（灰色區塊、巢狀指令）
• 偵錯時呼叫堆疊混亂
• 編譯器無法分析灰色區塊內程式碼
• 易產生「Release 版本行為異常」的 Bug

C# 的解決方案：ConditionalAttribute

[Conditional("DEBUG")]
private void DebugOnlyMethod() { ... }

編譯器識別此屬性：若符號未定義，直接移除所有呼叫指令（含引數評估），方法本體保留於組件中但無人呼叫。

經典用例：前置/後置條件驗證

傳統寫法：

private void CheckState()
{
#if DEBUG
    Trace.WriteLine("Entering CheckState");
    // ... 驗證邏輯
    Trace.WriteLine("Exiting CheckState");
#endif
}

問題：Release 建置仍保留空方法呼叫，有微小開銷；且若不小心在 #if 內放有副作用程式碼會產生 Bug。

條件屬性運作機制

1. 方法標記 [Conditional("SYMBOL")]
2. 呼叫端編譯時，編譯器檢查符號是否定義
3. 未定義 → 完全移除呼叫指令，如同程式碼不存在
4. 定義 → 保留呼叫，正常執行

為何優於 #if

• 零開銷：Release 版本連呼叫指令都沒有
• 無副作用風險：引數運算式連同呼叫一起被移除
• 程式碼乾淨：驗證邏輯集中在方法內，呼叫端無雜訊
• 工具友善：重構、尋找參考、IntelliSense 正常運作

適用場景

• 偵錯斷言 Debug.Assert
• 追蹤輸出 Trace.WriteLine
• 效能計數器、診斷日誌
• 單元測試專用輔助方法