Note
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier les répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de changer de répertoire.
Remarque
Cet article est spécifique à .NET Framework. Elle ne s’applique pas aux implémentations plus récentes de .NET, notamment .NET 6 et versions ultérieures.
Les attributs d'affichage du débogueur permettent au développeur qui définit et connaît le mieux le comportement d'exécution d'un type, de préciser également l'apparence de ce type lorsqu'il est affiché dans un débogueur. De plus, les attributs d’affichage du débogueur qui fournissent une Target propriété peuvent être appliqués au niveau de l’assembly par les utilisateurs sans connaître le code source. L’attribut DebuggerDisplayAttribute contrôle l’affichage d’un type ou d’un membre dans les fenêtres de variables du débogueur. L’attribut DebuggerBrowsableAttribute détermine si et comment un champ ou une propriété s’affiche dans les fenêtres de variables du débogueur. L’attribut DebuggerTypeProxyAttribute spécifie un type de remplacement ou un proxy pour un type et modifie la façon dont le type est affiché dans les fenêtres du débogueur. Lorsque vous affichez une variable qui a un proxy ou un type de remplacement, le proxy correspond au type d’origine dans la fenêtre d’affichage du débogueur. La fenêtre de variables du débogueur n'affiche que les membres publics du type proxy. Les membres privés ne sont pas affichés.
Utilisation de DebuggerDisplayAttribute
Le DebuggerDisplayAttribute constructeur a un seul argument : une chaîne à afficher dans la colonne valeur pour les instances du type. Cette chaîne peut contenir des accolades ({ et }). Le texte entre accolades est évalué comme une expression. Par exemple, le code C# suivant entraîne l’affichage de « Count = 4 » lorsque le signe plus (+) est sélectionné pour développer l’affichage du débogueur pour une instance de MyHashtable.
[DebuggerDisplay("Count = {count}")]
class MyHashtable
{
public int count = 4;
}
Les attributs appliqués aux propriétés référencées dans l’expression ne sont pas traités. Pour le compilateur C#, une expression générale est autorisée qui n’a qu’un accès implicite à cette référence pour l’instance actuelle du type cible. L’expression est limitée; il n’y a pas d’accès aux alias, aux variables locales, ni aux pointeurs. Dans le code C#, vous pouvez utiliser une expression générale entre des accolades qui donnent un accès implicite au pointeur this uniquement pour l'instance actuelle du type cible.
Par exemple, si un objet C# a une méthode redéfinie ToString(), le débogueur appellera la redéfinition et affichera son résultat au lieu du standard {<typeName>}.. Par conséquent, si vous avez redéfini ToString(), vous n’avez pas besoin d’utiliser DebuggerDisplayAttribute. Si vous utilisez les deux, l'attribut DebuggerDisplayAttribute prend la priorité sur la substitution de ToString().
Utilisation de DebuggerBrowsableAttribute
Appliquez le DebuggerBrowsableAttribute à un champ ou à une propriété pour spécifier la façon dont le champ ou la propriété doit être affiché dans la fenêtre du débogueur. Le constructeur de cet attribut prend l’une des valeurs d’énumération DebuggerBrowsableState , qui spécifie l’un des états suivants :
Never indique que le membre n’est pas affiché dans la fenêtre de données. Par exemple, l’utilisation de cette valeur pour le DebuggerBrowsableAttribute sur un champ supprime le champ de la hiérarchie ; le champ n’est pas affiché lorsque vous étendez le type englobant en cliquant sur le signe plus (+) pour l’instance du type.
Collapsed indique que le membre est affiché mais n’est pas développé par défaut. Il s’agit du comportement par défaut.
RootHidden indique que le membre lui-même n’est pas affiché, mais que ses objets constituants sont affichés s’il s’agit d’un tableau ou d’une collection.
Remarque
Le DebuggerBrowsableAttribute fichier n’est pas pris en charge par Visual Basic dans .NET Framework version 2.0.
L’exemple de code suivant montre l’utilisation de DebuggerBrowsableAttribute pour empêcher la propriété qui la suit d’apparaître dans la fenêtre de débogage de la classe.
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public static string y = "Test String";
Utilisation de DebuggerTypeProxy
Utilisez l’attribut DebuggerTypeProxyAttribute lorsque vous devez modifier considérablement et fondamentalement la vue de débogage d’un type, mais pas modifier le type lui-même. L’attribut DebuggerTypeProxyAttribute est utilisé pour spécifier un proxy d’affichage pour un type, ce qui permet à un développeur d’adapter la vue pour le type. Cet attribut, comme le DebuggerDisplayAttribute, peut être utilisé au niveau de l’assembly, auquel cas la Target propriété spécifie le type pour lequel le proxy sera utilisé. L’utilisation recommandée est que cet attribut spécifie un type imbriqué privé qui se produit dans le type auquel l’attribut est appliqué. Évaluateur d’expression qui prend en charge les visionneuses de types vérifie cet attribut lorsqu’un type est affiché. Si l’attribut est trouvé, l’évaluateur d’expression remplace le type auquel l’attribut est appliqué par le type de proxy d’affichage.
Lorsque DebuggerTypeProxyAttribute est présent, la fenêtre des variables du débogueur affiche uniquement les membres publics du type proxy. Les membres privés ne sont pas affichés. Le comportement de la fenêtre de données n’est pas modifié par les vues améliorées par attribut.
Pour éviter les pénalités de performances inutiles, les attributs du proxy d’affichage ne sont pas traités tant que l’objet n’est pas développé, soit via l’utilisateur qui clique sur le signe plus (+) en regard du type dans une fenêtre de données, soit via l’application de l’attribut DebuggerBrowsableAttribute . Par conséquent, il est recommandé qu’aucun attribut ne soit appliqué au type d’affichage. Les attributs peuvent et doivent être appliqués dans le corps du type d’affichage.
L’exemple de code suivant montre comment utiliser le type DebuggerTypeProxyAttribute pour spécifier un type à utiliser comme proxy d’affichage du débogueur.
[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;
}
}
}
Exemple :
Descriptif
L'exemple de code suivant peut être affiché dans Visual Studio pour voir les résultats de l'application des attributs DebuggerDisplayAttribute, DebuggerBrowsableAttribute, et DebuggerTypeProxyAttribute.
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
Voir aussi
Collaborez avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner des problèmes et des demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
