Foutopsporing verbeteren met de weergavekenmerken van het foutopsporingsprogramma
Notitie
Dit artikel is specifiek voor .NET Framework. Dit geldt niet voor nieuwere implementaties van .NET, waaronder .NET 6 en nieuwere versies.
Met weergavekenmerken van foutopsporingsprogramma kan de ontwikkelaar van het type, die het runtimegedrag van dat type opgeeft en het beste begrijpt, ook opgeven hoe dat type eruitziet wanneer dit wordt weergegeven in een foutopsporingsprogramma. Daarnaast kunnen de kenmerken van het foutopsporingsprogramma die een Target eigenschap bieden, worden toegepast op assemblyniveau door gebruikers zonder kennis van de broncode. Het DebuggerDisplayAttribute kenmerk bepaalt hoe een type of lid wordt weergegeven in de variabelevensters voor foutopsporingsprogramma's. Het DebuggerBrowsableAttribute kenmerk bepaalt of en hoe een veld of eigenschap wordt weergegeven in de variabele vensters van het foutopsporingsprogramma. Het DebuggerTypeProxyAttribute kenmerk geeft een vervangend type, of een proxy, op voor een type en wijzigt de manier waarop het type wordt weergegeven in foutopsporingsprogrammavensters. Wanneer u een variabele met een proxy of een vervangend type bekijkt, staat de proxy voor het oorspronkelijke type in het weergavevenster van het foutopsporingsprogramma. In het venster van de foutopsporingsprogrammavariabele worden alleen de openbare leden van het proxytype weergegeven. Privéleden worden niet weergegeven.
DebuggerDisplayAttribute gebruiken
De DebuggerDisplayAttribute constructor heeft één argument: een tekenreeks die moet worden weergegeven in de waardekolom voor exemplaren van het type. Deze tekenreeks kan accolades ({ en }) bevatten. De tekst binnen een paar accolades wordt geëvalueerd als een expressie. De volgende C#-code zorgt er bijvoorbeeld voor dat 'Count = 4' wordt weergegeven wanneer het plusteken (+) is geselecteerd om het foutopsporingsprogramma voor een exemplaar uit MyHashtablete vouwen.
[DebuggerDisplay("Count = {count}")]
class MyHashtable
{
public int count = 4;
}
Kenmerken die worden toegepast op eigenschappen waarnaar in de expressie wordt verwezen, worden niet verwerkt. Voor de C#-compiler is een algemene expressie toegestaan die alleen impliciete toegang tot deze verwijzing heeft voor het huidige exemplaar van het doeltype. De expressie is beperkt; er is geen toegang tot aliassen, lokale bevolking of aanwijzers. In C#-code kunt u een algemene expressie gebruiken tussen de accolades met impliciete toegang tot de this aanwijzer voor het huidige exemplaar van het doeltype.
Als een C#-object bijvoorbeeld een overschreven ToString()object heeft, roept het foutopsporingsprogramma de onderdrukking aan en geeft het resultaat weer in plaats van de standaard {<typeName>}. . Als u dit hebt overschreven ToString(), hoeft u niet te gebruiken DebuggerDisplayAttribute. Als u beide gebruikt, heeft het DebuggerDisplayAttribute kenmerk voorrang op de ToString() onderdrukking.
DebuggerBrowsableAttribute gebruiken
Pas het DebuggerBrowsableAttribute veld of de eigenschap toe op een veld of eigenschap om op te geven hoe het veld of de eigenschap moet worden weergegeven in het foutopsporingsprogrammavenster. De constructor voor dit kenmerk gebruikt een van de DebuggerBrowsableState opsommingswaarden, die een van de volgende statussen aangeeft:
Never geeft aan dat het lid niet wordt weergegeven in het gegevensvenster. Als u bijvoorbeeld deze waarde voor het DebuggerBrowsableAttribute veld in een veld gebruikt, wordt het veld uit de hiërarchie verwijderd. Het veld wordt niet weergegeven wanneer u het insluittype uitvouwt door op het plusteken (+) voor het typeexemplaren te klikken.
Collapsed geeft aan dat het lid wordt weergegeven, maar niet standaard is uitgevouwen. Dit is het standaardgedrag.
RootHidden geeft aan dat het lid zelf niet wordt weergegeven, maar dat de samenstellende objecten worden weergegeven als het een matrix of verzameling is.
Notitie
Het DebuggerBrowsableAttribute wordt niet ondersteund door Visual Basic in .NET Framework versie 2.0.
In het volgende codevoorbeeld ziet u het gebruik van de DebuggerBrowsableAttribute eigenschap om te voorkomen dat de volgende eigenschap wordt weergegeven in het foutopsporingsvenster voor de klasse.
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public static string y = "Test String";
DebuggerTypeProxy gebruiken
Gebruik het DebuggerTypeProxyAttribute kenmerk wanneer u de foutopsporingsweergave van een type aanzienlijk en fundamenteel moet wijzigen, maar niet het type zelf. Het DebuggerTypeProxyAttribute kenmerk wordt gebruikt om een weergaveproxy voor een type op te geven, zodat een ontwikkelaar de weergave voor het type kan aanpassen. Dit kenmerk, zoals het DebuggerDisplayAttributekenmerk, kan worden gebruikt op assemblyniveau. In dat geval geeft de Target eigenschap het type op waarvoor de proxy wordt gebruikt. Het aanbevolen gebruik is dat dit kenmerk een privé genest type opgeeft dat voorkomt binnen het type waarop het kenmerk wordt toegepast. Een expressie-evaluator die ondersteuning biedt voor typeviewers, controleert op dit kenmerk wanneer een type wordt weergegeven. Als het kenmerk wordt gevonden, vervangt de expressie-evaluator het weergaveproxytype voor het type waarop het kenmerk wordt toegepast.
Wanneer de DebuggerTypeProxyAttribute variabele aanwezig is, worden in het venster voor foutopsporingsprogramma alleen de openbare leden van het proxytype weergegeven. Privéleden worden niet weergegeven. Het gedrag van het gegevensvenster wordt niet gewijzigd door verbeterde weergaven met kenmerken.
Om onnodige prestatiestraffen te voorkomen, worden kenmerken van de weergaveproxy pas verwerkt als het object is uitgevouwen, door de gebruiker te klikken op het plusteken (+) naast het type in een gegevensvenster of via de toepassing van het DebuggerBrowsableAttribute kenmerk. Daarom wordt aanbevolen dat er geen kenmerken worden toegepast op het weergavetype. Kenmerken kunnen en moeten worden toegepast in de hoofdtekst van het weergavetype.
In het volgende codevoorbeeld ziet u het gebruik van het DebuggerTypeProxyAttribute type dat moet worden gebruikt als een weergaveproxy voor foutopsporingsprogramma's.
[DebuggerTypeProxy(typeof(HashtableDebugView))]
class MyHashtable : Hashtable
{
private const string TestString =
"This should not appear in the debug window.";
internal class HashtableDebugView
{
private Hashtable hashtable;
public const string TestStringProxy =
"This should appear in the debug window.";
// The constructor for the type proxy class must have a
// constructor that takes the target type as a parameter.
public HashtableDebugView(Hashtable hashtable)
{
this.hashtable = hashtable;
}
}
}
Opmerking
Beschrijving
Het volgende codevoorbeeld kan worden weergegeven in Visual Studio om de resultaten te zien van het toepassen van de DebuggerDisplayAttribute, DebuggerBrowsableAttributeen DebuggerTypeProxyAttribute kenmerken.
Code
using namespace System;
using namespace System::Collections;
using namespace System::Diagnostics;
using namespace System::Reflection;
ref class HashtableDebugView;
[DebuggerDisplay("{value}", Name = "{key}")]
ref class KeyValuePairs
{
private:
IDictionary^ dictionary;
Object^ key;
Object^ value;
public:
KeyValuePairs(IDictionary^ dictionary, Object^ key, Object^ value)
{
this->value = value;
this->key = key;
this->dictionary = dictionary;
}
};
[DebuggerDisplay("Count = {Count}")]
[DebuggerTypeProxy(HashtableDebugView::typeid)]
ref class MyHashtable : Hashtable
{
private:
static const String^ TestString = "This should not appear in the debug window.";
internal:
ref class HashtableDebugView
{
private:
Hashtable^ hashtable;
public:
static const String^ TestString = "This should appear in the debug window.";
HashtableDebugView(Hashtable^ hashtable)
{
this->hashtable = hashtable;
}
[DebuggerBrowsable(DebuggerBrowsableState::RootHidden)]
property array<KeyValuePairs^>^ Keys
{
array<KeyValuePairs^>^ get()
{
array<KeyValuePairs^>^ keys = gcnew array<KeyValuePairs^>(hashtable->Count);
IEnumerator^ ie = hashtable->Keys->GetEnumerator();
int i = 0;
Object^ key;
while (ie->MoveNext())
{
key = ie->Current;
keys[i] = gcnew KeyValuePairs(hashtable, key, hashtable[key]);
i++;
}
return keys;
}
}
};
};
public ref class DebugViewTest
{
private:
// The following constant will appear in the debug window for DebugViewTest.
static const String^ TabString = " ";
public:
// The following DebuggerBrowsableAttribute prevents the property following it
// from appearing in the debug window for the class.
[DebuggerBrowsable(DebuggerBrowsableState::Never)]
static String^ y = "Test String";
static void Main()
{
MyHashtable^ myHashTable = gcnew MyHashtable();
myHashTable->Add("one", 1);
myHashTable->Add("two", 2);
Console::WriteLine(myHashTable->ToString());
Console::WriteLine("In Main.");
}
};
int main()
{
DebugViewTest::Main();
}
using System;
using System.Collections;
using System.Diagnostics;
using System.Reflection;
class DebugViewTest
{
// The following constant will appear in the debug window for DebugViewTest.
const string TabString = " ";
// The following DebuggerBrowsableAttribute prevents the property following it
// from appearing in the debug window for the class.
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public static string y = "Test String";
static void Main()
{
MyHashtable myHashTable = new MyHashtable();
myHashTable.Add("one", 1);
myHashTable.Add("two", 2);
Console.WriteLine(myHashTable.ToString());
Console.WriteLine("In Main.");
}
}
[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;
}
}
[DebuggerDisplay("Count = {Count}")]
[DebuggerTypeProxy(typeof(HashtableDebugView))]
class MyHashtable : Hashtable
{
private const string TestString = "This should not appear in the debug window.";
internal class HashtableDebugView
{
private Hashtable hashtable;
public const string TestString = "This should appear in the debug window.";
public HashtableDebugView(Hashtable hashtable)
{
this.hashtable = hashtable;
}
[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public KeyValuePairs[] Keys
{
get
{
KeyValuePairs[] keys = new KeyValuePairs[hashtable.Count];
int i = 0;
foreach(object key in hashtable.Keys)
{
keys[i] = new KeyValuePairs(hashtable, key, hashtable[key]);
i++;
}
return keys;
}
}
}
}
Imports System.Collections
Imports System.Diagnostics
Imports System.Reflection
Class DebugViewTest
' The following constant will appear in the debug window for DebugViewTest.
Const TabString As String = " "
' The following DebuggerBrowsableAttribute prevents the property following it
' from appearing in the debug window for the class.
<DebuggerBrowsable(DebuggerBrowsableState.Never)> _
Public Shared y As String = "Test String"
Shared Sub Main()
Dim myHashTable As New MyHashtable()
myHashTable.Add("one", 1)
myHashTable.Add("two", 2)
Console.WriteLine(myHashTable.ToString())
Console.WriteLine("In Main.")
End Sub
End Class
<DebuggerDisplay("{value}", Name:="{key}")> _
Friend Class KeyValuePairs
Private dictionary As IDictionary
Private key As Object
Private value As Object
Public Sub New(ByVal dictionary As IDictionary, ByVal key As Object, ByVal value As Object)
Me.value = value
Me.key = key
Me.dictionary = dictionary
End Sub
End Class
<DebuggerDisplay("Count = {Count}"), DebuggerTypeProxy(GetType(MyHashtable.HashtableDebugView))> _
Class MyHashtable
Inherits Hashtable
Private Const TestString As String = "This should not appear in the debug window."
Friend Class HashtableDebugView
Private hashtable As Hashtable
Public Shared TestString As String = "This should appear in the debug window."
Public Sub New(ByVal hashtable As Hashtable)
Me.hashtable = hashtable
End Sub
<DebuggerBrowsable(DebuggerBrowsableState.RootHidden)> _
ReadOnly Property Keys as KeyValuePairs()
Get
Dim nkeys(hashtable.Count - 1) As KeyValuePairs
Dim i as Integer = 0
For Each key As Object In hashtable.Keys
nkeys(i) = New KeyValuePairs(hashtable, key, hashtable(key))
i = i + 1
Next
Return nkeys
End Get
End Property
End Class
End Class
