È possibile creare un metodo Debug-only in .NET?

Question

È possibile creare un metodo che esegue l'assistenza per il debug come la classe System.Diagnostics.Debug?

Sto cercando un modo per costruire un metodo che quando viene chiamato da un assembly compilato con il simbolo di compilazione condizionale DEBUG definito, restituisce un'operazione e che è un no-op quando viene chiamato da un assembly senza il simbolo definito.

Se possibile, mi piacerebbe che le chiamate ai metodi di debug aggiungessero un sovraccarico minimo o aumentassero di dimensioni alla versione di rilascio dell'assieme.

Per chiarire, i metodi di debug devono essere in un assembly compilato in modalità di rilascio. Le chiamate ai metodi dovrebbero generare solo le operazioni quando vengono chiamate da un assembly con il simbolo DEBUG definito nell'ambito della chiamata al metodo.

Answer 1

aggiungere il Conditional attribuiscono al metodo, in questo modo:

[Conditional("DEBUG")] 
public void Whatever() { 
    //... 
} 

noti che esimo Il metodo deve restituire void e non può avere alcun parametro out; altrimenti, sarebbe impossibile rimuovere una chiamata.

Il metodo verrà compilato nell'assieme, ma i compilatori conformi a CLS emetteranno solo chiamate al metodo se gli assembly che stanno compilando DEBUG è definito. Si noti che il compilatore C++ non è conforme a CLS e emetterà sempre la chiamata.

Answer 2

ConditionalAttribute

BTW il codice per il metodo di essere chiamato rimane in assemblea - è le chiamate a esso che vengono rimossi al momento della compilazione

Bonus attualità post del blog: http://blogs.msdn.com/ericlippert/archive/2009/09/10/what-s-the-difference-between-conditional-compilation-and-the-conditional-attribute.aspx

Answer 3

Se si smonta classe System.Diagnostics.Debug utilizzando Reflector si può vedere che questo viene fatto utilizzando l'attributo [Conditional("DEBUG")]:

public sealed class Debug 
{ 
    private Debug(); 
    [Conditional("DEBUG")] 
    public static void Assert(bool condition); 
    // etc... 
} 

Answer 4

Se avete bisogno di un'altra firma di func vuoto (..) senza parametri fuori, quello che sarebbe sbagliato con

MyDebugObject Foo(out int justForGrins) 
{ 
    justForGrins = <safe value for release builds>; 
    MyDebugObject result = <safe value for release builds>; 
    #if DEBUG 
    .. run code you need for your debugging... 
    #endif 
    return result; 
} 

e 'più prolisso e meno elegante rispetto al ConditionalAttribute, ma permetterebbe una firma più flessibile.

Answer 5

Perché non provare qualcosa di simile?

#if DEBUG 
     private void DebugLog(string message) 
     { 
      // do whatever u want. 
     } 
#endif