＃如果DEBUG與條件（ 「調試」）

Question

哪個更好用，爲什麼呢，一個大項目：

#if DEBUG 
    public void SetPrivateValue(int value) 
    { ... } 
#endif 

或

[System.Diagnostics.Conditional("DEBUG")] 
public void SetPrivateValue(int value) 
{ ... } 

Answer 1

這真的取決於你要什麼：

• #if DEBUG：這裏的代碼甚至不會在發佈時達到IL。
• [Conditional("DEBUG")]：該代碼將到達IL，但是調用，除非調用方編譯時設置了DEBUG，否則該方法將被省略。

我個人使用都視情況而定：

條件（「調試」）例：我用這個讓我沒有回去釋放過程中稍後編輯我的代碼，但在調試過程中，我想確保我沒有任何錯別字。這個函數檢查我試圖在我的INotifyPropertyChanged東西中使用它時正確地鍵入一個屬性名稱。

[Conditional("DEBUG")] 
[DebuggerStepThrough] 
protected void VerifyPropertyName(String propertyName) 
{ 
    if (TypeDescriptor.GetProperties(this)[propertyName] == null) 
     Debug.Fail(String.Format("Invalid property name. Type: {0}, Name: {1}", 
      GetType(), propertyName)); 
} 

你真的不希望創建使用#if DEBUG的功能，除非你願意換每次調用該函數具有相同#if DEBUG：

#if DEBUG 
    public void DoSomething() { } 
#endif 

    public void Foo() 
    { 
#if DEBUG 
     DoSomething(); //This works, but looks FUGLY 
#endif 
    } 

與：

[Conditional("DEBUG")] 
public void DoSomething() { } 

public void Foo() 
{ 
    DoSomething(); //Code compiles and is cleaner, DoSomething always 
        //exists, however this is only called during DEBUG. 
} 

---

的#if DEBUG例如：當我嘗試爲WCF通信設置不同的綁定時，我使用它。

#if DEBUG 
     public const String ENDPOINT = "Localhost"; 
#else 
     public const String ENDPOINT = "BasicHttpBinding"; 
#endif 

在第一個例子中，所有存在的，但只是忽略，除非DEBUG上的代碼。在第二個示例中，取決於是否設置了DEBUG，將const ENDPOINT設置爲「Localhost」或「BasicHttpBinding」。

---

更新：因爲這個答案是最高的投票問題的答案，我更新這個答案澄清的一個重要和棘手的問題。如果您選擇使用ConditionalAttribute，請記住，在編譯過程中忽略調用，並且而不是運行時。那就是：

MyLibrary.dll

[Conditional("DEBUG")] 
public void A() 
{ 
    Console.WriteLine("A"); 
    B(); 
} 

[Conditional("DEBUG")] 
public void B() 
{ 
    Console.WriteLine("B"); 
} 

如果庫對釋放模式（即沒有調試符號），它會永遠有從A()中省略B()調用，即使調用編譯包含A()是因爲在調用程序集中定義了DEBUG。

Answer 2

嗯，這是值得注意的是，他們並不意味着同樣的事情。

如果沒有定義DEBUG符號，然後在第一種情況下SetPrivateValue本身不會叫......而在第二種情況下，它會存在，但任何呼叫者誰是沒有調試符號編譯將省略這些呼叫。

如果代碼及其所有來電號碼在同一裝配這種差異是少重要 - 但它意味着，在第一種情況下，你也需要有圍繞調用代碼#if DEBUG爲好。

就我個人而言，我會推薦第二種方法 - 但您確實需要保持頭腦中清晰的差異。

Answer 3

隨着第一例子中，SetPrivateValue不會在構建存在如果DEBUG沒有定義，與第二示例中，調用如果沒有定義DEBUG到SetPrivateValue不會在構建存在。

第一個示例中，您必須將所有調用與#if DEBUG包裝在一起。

第二個示例中，將忽略對SetPrivateValue的調用，但請注意，SetPrivateValue本身仍將被編譯。如果您正在構建庫，這非常有用，因此引用庫的應用程序仍然可以使用您的函數（如果符合條件）。

如果你想省略呼叫和保存被叫用戶的空間，你可以使用這兩種技術的結合：

[System.Diagnostics.Conditional("DEBUG")] 
public void SetPrivateValue(int value){ 
    #if DEBUG 
    // method body here 
    #endif 
} 

Answer 4

讓我們假設你的代碼也有其定義一個空存根功能，解決的喬恩斯基特的點之一的#else聲明。這兩者之間還有一個重要的區別。

假設#if DEBUG或Conditional函數存在於您的主項目可執行文件引用的DLL中。使用#if，將根據庫的編譯設置對條件進行評估。使用Conditional屬性，將對調用者的編譯設置執行條件評估。

Answer 5

我敢肯定，很多會同意我的看法，但花了時間作爲構建傢伙不斷聽到「但它的作品在我的機器！」，我帶你應該幾乎從來不使用任何的立場。如果你確實需要測試和調試的東西，找出一種方法來使測試性與實際生產代碼分離。

摘要在單元測試中嘲笑場景，爲您想要測試的場景製作一個版本的測試版本，但不要將測試用於調試，而是將代碼用於測試和編寫用於生產版本的二進制代碼。這些調試測試只是隱藏了開發人員可能出現的錯誤，所以直到後來才發現它們。

Answer 6

我有一個SOAP WebService擴展使用自定義[TraceExtension]來記錄網絡流量。我僅將它用於Debug版本，並從Release版本中省略。使用#if DEBUG來包裝[TraceExtension]屬性，從而將其從Release版本中刪除。

#if DEBUG 
[TraceExtension] 
#endif 
[System.Web.Service.Protocols.SoapDocumentMethodAttribute(...)] 
[ more attributes ...] 
public DatabaseResponse[] GetDatabaseResponse(...) 
{ 
    object[] results = this.Invoke("GetDatabaseResponse",new object[] { 
      ... parmeters}}; 
} 

#if DEBUG 
[TraceExtension] 
#endif 
public System.IAsyncResult BeginGetDatabaseResponse(...) 

#if DEBUG 
[TraceExtension] 
#endif 
public DatabaseResponse[] EndGetDatabaseResponse(...) 

Answer 7

這一個可以是有用的，以及：

if (Debugger.IsAttached) 
{ 
... 
}