Est-il possible de créer une méthode Debug uniquement dans .NET?

Question

Est-il possible de créer une méthode qui effectue une assistance de débogage comme la classe System.Diagnostics.Debug?

Je cherche un moyen de construire une méthode qui, lorsqu'elle est appelée par un assembly compilé avec le symbole de compilation conditionnel DEBUG défini, aboutit à une opération, et qui est une no-op lorsqu'elle est appelée par un assembly sans le symbole défini.

Si possible, j'aimerais que les appels aux méthodes de débogage permettent d'ajouter un surcoût minimal ou d'augmenter la taille de la version finale de l'assembly. Pour clarifier, les méthodes de débogage doivent être dans un assembly compilé en mode Release. Les appels aux méthodes ne doivent générer des opérations que s'ils sont appelés à partir d'un assembly avec le symbole DEBUG défini dans la portée de l'appel de méthode.

Answer 1

Ajouter la Conditional attribut à la méthode, comme ceci:

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

Notez que e La méthode doit renvoyer void et ne peut avoir aucun paramètre out; sinon, il serait impossible de supprimer un appel.

La méthode sera compilée dans l'assembly, mais les compilateurs compatibles CLS n'émettront des appels à la méthode que si les assemblages qu'ils compilent ont défini DEBUG. Notez que le compilateur C++ n'est pas compatible CLS et émettra toujours l'appel.

Answer 2

ConditionalAttribute

BTW le code de la méthode appelée reste dans l'ensemble - ce sont les appels à ce qui sont supprimés au moment de la compilation

Bonus de blog d'actualité: http://blogs.msdn.com/ericlippert/archive/2009/09/10/what-s-the-difference-between-conditional-compilation-and-the-conditional-attribute.aspx

Answer 3

Si vous démontez la classe System.Diagnostics.Debug utilisant Reflector vous pouvez voir que cela se fait en utilisant l'attribut [Conditional("DEBUG")]:

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

Answer 4

Si vous avez besoin d'une autre signature que void Func (..) sans paramètres, à la ce serait mal à

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; 
} 

il est plus bavard et moins élégant que le ConditionalAttribute, mais il vous permettra une signature plus souple.

Answer 5

Pourquoi ne pas essayer quelque chose comme ça?

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