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

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

Questi sono l'uso DebuggerDisplayAttributee il ToString()metodo.

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 motivo per non fare entrambe le cose? È una preferenza puramente personale?

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

Questo può essere o meno una buona cosa.

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

Ad esempio, nel tuo caso, l'implementazione "ToString" mi sembra strana. Mi aspetto che un'implementazione ToString () della classe "Person" restituisca direttamente il nome, non "Name = PersonsName". Tuttavia, durante il debug, potrei volere queste informazioni extra.

"Quando crei una classe o una struttura personalizzata, devi sovrascrivere il metodo ToString per fornire informazioni sul tuo tipo al codice client." - MSDN

Se ciò che ToString()ritorna e vedi nel debugger non è quello che vorresti, allora lo usi DebuggerDisplayAttribute.

La lentezza del debugger può anche essere presa in considerazione:

DebuggerDisplayAttributel'espressione di formato viene interpretata dal debugger dopo ogni passaggio / punto di interruzione del debug.

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

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