Debugowanie C #: [DebuggerDisplay] czy ToString ()?

Istnieją dwa sposoby na zwiększenie użyteczności debugowania informacji zamiast ich wyświetlania {MyNamespace.MyProject.MyClass}w debugerze.

Oto zastosowanie DebuggerDisplayAttributei ToString()metoda.

using System.Diagnostics;
...

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

lub

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

Czy jest jakiś powód, aby preferować jedno od drugiego? Jest jakiś powód, by nie robić obu tych rzeczy? Czy to czysto osobiste preferencje?

Używanie [DebuggerDisplay]jest przeznaczone tylko dla debugera. Zastępowanie ToString () ma „efekt uboczny” zmiany sposobu wyświetlania w czasie wykonywania.

To może być dobre, ale nie musi.

Często podczas debugowania chcesz uzyskać więcej informacji niż standardowe ToString()wyjście, w takim przypadku użyjesz obu.

Na przykład w twoim przypadku implementacja „ToString” wydaje mi się dziwna. Spodziewałbym się, że implementacja ToString () klasy „Person” zwróci bezpośrednio nazwę Name, a nie „Name = PersonsName”. Jednak podczas debugowania mogę potrzebować dodatkowych informacji.

„Tworząc klasę lub strukturę niestandardową, należy zastąpić metodę ToString, aby dostarczyć informacje o typie do kodu klienta”. - MSDN

Jeśli to, co ToString()powróci i zobaczysz w debugerze, nie jest tym, czego chciałbyś, użyj DebuggerDisplayAttribute.

Można również wziąć pod uwagę powolność debuggera:

DebuggerDisplayAttributewyrażenie formatu jest interpretowane przez debuger po każdym kroku debugowania / punkcie przerwania.

ToStringjest wkompilowany w Twój kod i dlatego jest znacznie szybszy do wykonania przez debuger.

To samo dotyczy warunkowych punktów przerwania: jeśli wyrażenie warunkowe jest zbyt wolne, aby zinterpretować je przez debuger za każdym razem, gdy wykonanie osiągnie punkt przerwania, przydatne może być usunięcie punktu przerwania i zamiast tego dodanie tymczasowego kodu w następujący sposób: if (condition) Debugger.Break();