Debugger mit dem DebuggerDisplay-Attribut anweisen, was angezeigt werden soll (C#, Visual Basic, F#, C++/CLI)

  • Artikel

Das DebuggerDisplayAttribute steuert die Anzeige von Objekten, Eigenschaften oder Feldern in den Variablenfenstern des Debuggers. Dieses Attribut kann auf Typen (Klassen, Strukturen, Enumerationen, Delegate) angewendet werden. Wenn das Attribut auf einen Basistyp angewendet wird, gilt es auch für eine Unterklasse.

Das DebuggerDisplay -Attribut verfügt über ein einziges Argument, das als Zeichenfolge in der Wertspalte für Instanzen des Typs angezeigt wird. Diese Zeichenfolge kann geschweifte Klammern ({ und }) enthalten. Text innerhalb von Klammern wird als Feld, Eigenschaft oder Methode ausgewertet.

Wenn eine Klasse eine überschriebene ToString() -Methode aufweist, verwendet der Debugger die überschriebene Methode anstelle des standardmäßigen {<typeName>}. Wenn Sie also die Methode ToString() überschrieben haben, verwendet der Debugger die überschriebene Methode anstelle des standardmäßigen {<typeName>}, und DebuggerDisplay ist nicht erforderlich. Wenn Sie beides verwenden, hat das DebuggerDisplay-Attribut Vorrang vor der überschriebenen ToString()-Methode. Das DebuggerDisplay-Attribut besitzt auch Vorrang vor der überschriebenen ToString()-Methode in einer Unterklasse.

Ob der Debugger diesen impliziten ToString()-Aufruf auswertet, hängt von einer Benutzereinstellung im Dialogfeld Extras/Optionen/Debugging ab.

Wichtig

Wenn das Kontrollkästchen Unformatierte Struktur von Objekten in Variablenfenstern anzeigen im Dialogfeld Extras/Optionen/Debugging aktiviert ist, wird das DebuggerDisplay-Attribut ignoriert.

Hinweis

Für nativen Code wird dieses Attribut nur in C++-/CLI-Code unterstützt.

In der folgenden Tabelle werden einige Verwendungsmöglichkeiten des DebuggerDisplay -Attributs sowie Beispielausgaben gezeigt.

Attribut In der Spalte „Wert“ angezeigte Ausgabe
[DebuggerDisplay("x = {x} y = {y}")]

Angewendet auf einen Typ mit den Feldern x und y.		 x = 5 y = 18
[DebuggerDisplay("String value is {getString()}")]Die Parametersyntax kann je nach Sprache unterschiedlich sein. Achten Sie deshalb besonders auf die Syntax. String value is [5, 6, 6]

DebuggerDisplay kann auch benannte Parameter akzeptieren.

Parameter Zweck
Name, Type Diese Parameter beeinflussen die Spalten Name und Typ der Variablenfenster. (Sie können unter Verwendung der gleichen Syntax wie beim Konstruktor auf Zeichenfolgen festgelegt werden.) Eine übermäßige oder falsche Verwendung dieser Parameter kann zu verwirrenden Ausgaben führen.
Target, TargetTypeName Gibt den Zieltyp an, wenn das Attribut auf Assemblyebene verwendet wird.

In der Datei „autoexp.cs“ wird das DebuggerDisplay-Attribut auf Assemblyebene verwendet. Die Datei „autoexp.cs“ legt die Standarderweiterungen fest, die Visual Studio für .NET-Objekte verwendet. Suchen Sie in der Datei „autoexp.cs“ Beispiele zur Verwendung des DebuggerDisplay-Attributs, oder bearbeiten und kompilieren Sie die Datei „autoexp.cs“, um die Standarderweiterungen zu ändern. Erstellen Sie eine Sicherungskopie der Datei "autoexp.cs", bevor Sie sie ändern.

Um „autoexp.cs“ zu erstellen, öffnen Sie die Developer-Eingabeaufforderung für VS2015, und führen Sie die folgenden Befehle aus.

cd <directory containing autoexp.cs>
csc /t:library autoexp.cs

Die Änderungen an „autoexp.dll“ werden in der nächsten Debugsitzung übernommen.

Verwenden von Ausdrücken in DebuggerDisplay

Obwohl ein allgemeiner Ausdruck zwischen den geschweiften Klammern in einem DebuggerDisplay-Attribut verwendet werden kann, wird diese Vorgehensweise nicht empfohlen.

Ein allgemeiner Ausdruck in DebuggerDisplay hat nur für die aktuelle Instanz des Zieltyps impliziten Zugriff auf den this -Zeiger. Der Ausdruck hat keinen Zugriff auf Aliase, lokale Variablen oder Zeiger. Wenn der Ausdruck auf Eigenschaften verweist, werden deren Attribute nicht verarbeitet. Beispielsweise würde der C#-Code [DebuggerDisplay("Object {count - 2}")] den Wert Object 6 anzeigen, wenn das Feld count 8 wäre.

Die Verwendung von Ausdrücken in DebuggerDisplay kann zu folgenden Problemen führen:

  • Das Auswerten von Ausdrücken ist der aufwändigste Vorgang im Debugger. Außerdem wird ein Ausdruck bei jedem Anzeigen ausgewertet. Dies kann bei der schrittweisen Ausführung des Codes Leistungsprobleme verursachen. Beispielsweise kann ein komplexer Ausdruck, der zum Anzeigen der Werte in einer Auflistung verwendet wird, die Ausführung des Codes sehr verlangsamen, wenn viele Elemente vorhanden sind.

  • Ausdrücke werden von der Ausdrucksauswertung in der Sprache des aktuellen Stapelrahmens und nicht von der Auswertung der Sprache ausgewertet, in der der Ausdruck geschrieben wurde. Dies kann unvorhersehbare Ergebnisse zur Folge haben, wenn die Sprachen unterschiedlich sind.

  • Durch Auswerten eines Ausdrucks kann der Zustand der Anwendung geändert werden. Beispielsweise ändert ein Ausdruck, der den Wert einer Eigenschaft festlegt, den Eigenschaftswert im ausgeführten Code.

    Eine Möglichkeit, eventuelle Probleme bei der Ausdrucksauswertung zu verringern, ist das Erstellen einer privaten Eigenschaft, die den Vorgang ausführt und eine Zeichenfolge zurückgibt. Das DebuggerDisplay-Attribut kann dann den Wert dieser privaten Eigenschaft anzeigen. Im folgenden Beispiel wird dieses Muster implementiert:

[DebuggerDisplay("{DebuggerDisplay,nq}")]
public sealed class MyClass
{
    public int count { get; set; }
    public bool flag { get; set; }
    private string DebuggerDisplay
    {
        get
        {
            return string.Format("Object {0}", count - 2);
        }
    }
}

Das Suffix „,nq“ weist die Ausdrucksauswertung an, die Anführungszeichen zu entfernen, wenn der endgültige Wert angezeigt wird (nq = no quotes, keine Anführungszeichen).

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie DebuggerDisplayzusammen mit DebuggerBrowsable und DebuggerTypeProxyverwendet wird. Bei der Anzeige in einem Variablenfenster des Debuggers (z. B. im Fenster Überwachen ) wird dadurch eine Erweiterung erzeugt, die folgendermaßen aussieht:

Name Wert Type
Key "three" object {string}
Wert 3 object {int} 
[DebuggerDisplay("{value}", Name = "{key}")]
internal class KeyValuePairs
{
    private IDictionary dictionary;
    private object key;
    private object value;
    public KeyValuePairs(IDictionary dictionary, object key, object value)
    {
        this.value = value;
        this.key = key;
        this.dictionary = dictionary;
    }

    public object Key
    {
        get { return key; }
        set
        {
            object tempValue = dictionary[key];
            dictionary.Remove(key);
            key = value;
            dictionary.Add(key, tempValue);
        }
    }

    public object Value
    {
        get { return this.value; }
        set
        {
            this.value = value;
            dictionary[key] = this.value;
        }
    }
}

[DebuggerDisplay("{DebuggerDisplay,nq}")]
[DebuggerTypeProxy(typeof(HashtableDebugView))]
class MyHashtable
{
    public Hashtable hashtable;

    public MyHashtable()
    {
        hashtable = new Hashtable();
    }

    private string DebuggerDisplay { get { return "Count = " + hashtable.Count; } }

    private class HashtableDebugView
    {
        private MyHashtable myhashtable;
        public HashtableDebugView(MyHashtable myhashtable)
        {
            this.myhashtable = myhashtable;
        }

        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
        public KeyValuePairs[] Keys
        {
            get
            {
                KeyValuePairs[] keys = new KeyValuePairs[myhashtable.hashtable.Count];

                int i = 0;
                foreach (object key in myhashtable.hashtable.Keys)
                {
                    keys[i] = new KeyValuePairs(myhashtable.hashtable, key, myhashtable.hashtable[key]);
                    i++;
                }
                return keys;
            }
        }
    }
}

Zugehöriger Inhalt