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

條件屬性實戰：偵錯驗證方法

[Conditional("DEBUG")]
private void CheckState()
{
    string caller = new StackTrace().GetFrame(1).GetMethod().Name;
    Trace.WriteLine($"Entering CheckState for Person (called by {caller})");

    Debug.Assert(_lastName != null, caller, "Last Name cannot be null");
    Debug.Assert(_lastName.Length > 0, caller, "Last Name cannot be blank");
    Debug.Assert(_firstName != null, caller, "First Name cannot be null");
    Debug.Assert(_firstName.Length > 0, caller, "First Name cannot be blank");

    Trace.WriteLine("Exiting CheckState for Person");
}

套用於屬性存取器

public string LastName
{
    get
    {
        CheckState(); // DEBUG 時執行驗證，RELEASE 時直接移除呼叫
        return _lastName;
    }
    set
    {
        CheckState();
        _lastName = value;
        CheckState();
    }
}

條件屬性 vs #if 優勢對比

#if 經典 Bug：引數副作用

public void BadExample()
{
    string msg = null;
#if DEBUG
    msg = GetDiagnostics(); // 只有 DEBUG 時賦值
#endif
    Console.WriteLine(msg); // RELEASE 印出 null → 空行，非預期！
}

條件屬性版本：

[Conditional("DEBUG")]
private void LogDiagnostics(string msg) { Console.WriteLine(msg); }

public void GoodExample()
{
    LogDiagnostics(GetDiagnostics()); // RELEASE 時整個呼叫（含引數評估）被移除
}

使用限制與注意

• 只能套用在 void 回傳的方法
• 不能用於介面方法、覆寫方法、委派目標
• 標記為 Conditional 的方法不可為 public（建議 private/internal）
• 多重條件：[Conditional("DEBUG"), Conditional("TRACE")] 任一符合即保留

最佳實務

1. 偵錯斷言、追蹤、日誌、效能計數器 → 用 Conditional("DEBUG")
2. 編譯時常數切換（如功能旗標）→ 用 #if FEATURE_X
3. 平台相關程式碼 → 用 #if NETCOREAPP / #if WINDOWS
4. 永遠不要在 #if 區塊內放置有副作用的運算式