C# debugging: [DebuggerDisplay] o ToString()?

Question

Esistono due modi per aumentare l'utilità delle informazioni di debug invece di vedere {MyNamespace.MyProject.MyClass} nel debugger.

Questi sono l'uso del metodo DebuggerDisplayAttribute e ToString().

using System.Diagnostics; 
... 

[DebuggerDisplay("Name = {Name}")] 
public class Person 
{ 
    public string Name; 
} 

o

public class Person 
{ 
    public string Name; 
    public override string ToString() 
    { 
     return string.Format("Name = {0}", Name); 
    } 
} 

C'è qualche motivo per preferire l'uno all'altro? Qualche ragione per non fare entrambe le cose? È una preferenza puramente personale?

Answer 1

L'utilizzo di [DebuggerDisplay] è inteso solo per il debugger. L'override di ToString() ha l'effetto collaterale di cambiare la visualizzazione in fase di esecuzione.

Questo può o non può essere una buona cosa.

Spesso, durante il debug si desiderano più informazioni rispetto all'output standard ToString(), nel qual caso si utilizzeranno entrambi.

Ad esempio, nel tuo caso, l'implementazione di "ToString" mi sembra strana. Mi aspetterei che un'implementazione ToString() della classe "Persona" restituisca semplicemente il nome direttamente, non "Nome = Identità persone". Tuttavia, durante il debug, potrei volere quelle informazioni extra.

Answer 2

"Quando si crea una classe o una struttura personalizzata, è necessario eseguire l'override del metodo ToString per fornire informazioni sul tipo al codice client." - MSDN

Se ToString() ritorna e si vede nel debugger non è quello che si desidera utilizzare allora DebuggerDisplayAttribute.

Answer 3

lentezza del debugger può anche essere presa in considerazione:

DebuggerDisplayAttribute espressione formato è interpretato dal debugger dopo ogni passaggio debugging/breakpoint.

ToString è compilato nel codice ed è quindi molto più veloce da eseguire dal debugger.

Questo è lo stesso con i punti di interruzione condizionali: se l'espressione condizionale è troppo lento per interpretare dal debugger ogni volta che l'esecuzione raggiunge il punto di interruzione, può essere utile per rimuovere il punto di interruzione e invece aggiungere il codice temporaneo in questo modo: if (condition) Debugger.Break();