デバッガー表示属性によるデバッグ機能の拡張
Note
この記事は .NET Framework に固有のものです。 .NET 6 以降のバージョンを含めて、.NET の新しい実装には適用されません。
デバッガー表示属性は、型を指定し、その型の実行時の動作を最もよく理解している型の開発者が、デバッガーで表示されたときに、その型がどのように見えるかも指定できるようにします。 さらに、Target プロパティを提供するデバッガー表示属性は、ソース コードの知識がなくても、ユーザーがアセンブリ レベルで適用することができます。 DebuggerDisplayAttribute 属性は、デバッガーの変数ウィンドウで型やメンバーを表示する方法を制御します。 DebuggerBrowsableAttribute 属性は、デバッガーの変数ウィンドウにフィールドまたはプロパティを表示するかどうか、および表示方法を決定します。 DebuggerTypeProxyAttribute 属性は、型に対して代理の型 (プロキシ) を指定し、その型をデバッガー ウィンドウで表示する方法を変更します。 プロキシ (代理の型) を指定した変数を表示すると、元の型の代理としてプロキシがデバッガーの表示ウィンドウに表示されます。 デバッガーの変数ウィンドウには、プロキシ型のパブリック メンバーのみが表示されます。 プライベート メンバーは表示されません。
DebuggerDisplayAttribute の使用
DebuggerDisplayAttribute コンストラクターには引数が 1 つあり、それは、型のインスタンスの値列に表示される文字列です。 この文字列には、中かっこ ({ と }) を含めることができます。 かっこ内のテキストは、式として評価されます。 たとえば、次の C# コードでは、MyHashtable のインスタンスのデバッガー表示を展開するプラス記号 (+) が選択された場合に、"Count = 4" が表示されます。
[DebuggerDisplay("Count = {count}")]
class MyHashtable
{
public int count = 4;
}
式で参照されるプロパティに適用される属性は処理されません。 C# コンパイラでは、対象の型の現在のインスタンスへのこの参照に対し、暗黙的なアクセスのみを持つ一般的な式が許可されています。 この式は制限されており、エイリアス、ローカル、またはポインターに対するアクセスはありません。 C# コードでは、対象となる型の現在のインスタンスのみの this ポインターに暗黙的にアクセスする一般的な式をかっこ内で使用できます。
たとえば、C# オブジェクトにオーバーライドされた ToString() がある場合、デバッガーはそのオーバーライドを呼び出し、標準の {<typeName>}. ではなく、その結果を表示します。したがって、オーバーライドされた ToString() がある場合、DebuggerDisplayAttribute を使用する必要はありません。 両方を使用すると、DebuggerDisplayAttribute 属性が ToString() オーバーライドよりも優先されます。
DebuggerBrowsableAttribute の使用
DebuggerBrowsableAttribute をフィールドまたはプロパティに適用して、デバッガー ウィンドウにフィールドまたはプロパティを表示する方法を指定します。 この属性のコンストラクターは、次の状態のいずれかを指定する DebuggerBrowsableState 列挙値を 1 つ取得します。
Never は、データ ウィンドウにメンバーが表示されないことを示します。 たとえば、この値をフィールドで DebuggerBrowsableAttribute に使用すると、そのフィールドが階層から削除され、型のインスタンスのプラス記号 (+) をクリックして囲む型を展開したときに、そのフィールドが表示されなくなります。
Collapsed は、メンバーが表示されますが、既定で展開されていないことを示します。 これは既定の動作です。
RootHidden は、メンバー自体は表示されませんが、メンバーが配列またはコレクションである場合は、その構成オブジェクトが表示されることを示します。
Note
.NET Framework バージョン 2.0 では、DebuggerBrowsableAttribute は Visual Basic でサポートされません。
次のコード例は、DebuggerBrowsableAttribute を使用して、それに続くプロパティがクラスのデバッグ ウィンドウに表示されないようにします。
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public static string y = "Test String";
DebuggerTypeProxy の使用
DebuggerTypeProxyAttribute 属性は、型のデバッグ ビューを大幅かつ根本的に変更する必要があるものの、型そのものは変えない場合に使用します。 DebuggerTypeProxyAttribute 属性は、開発者が型の表示を調整できるように、型の表示プロキシを指定するために使用します。 DebuggerDisplayAttribute と同様に、この属性は、アセンブリ レベルで使用できます。この場合、Target プロパティは、プロキシが使用される型を指定します。 推奨される使用法は、この属性が、属性が適用される型の中で発生するプライベートの入れ子にされた型を指定することです。 型ビューアーをサポートする式エバリュエーターが、型が表示されるときに、この属性をチェックします。 属性が見つかると、式エバリュエーターは、属性が適用される型の代わりに表示プロキシ型を使用します。
DebuggerTypeProxyAttribute が存在する場合は、デバッガーの変数ウィンドウには、プロキシ型のパブリック メンバーのみが表示されます。 プライベート メンバーは表示されません。 データ ウィンドウの動作は、属性拡張ビューでは変更されません。
不要なパフォーマンスの低下を避けるため、データ ウィンドウでユーザーが型の横にあるプラス記号 (+) をクリックするか、DebuggerBrowsableAttribute 属性の適用により、オブジェクトが展開されるまで、表示プロキシの属性は処理されません。 そのため、表示型に属性を適用しないことをお勧めします。 属性は、表示型の本体内で適用でき、また適用する必要があります。
次のコード例は、DebuggerTypeProxyAttribute を使用してデバッガーの表示プロキシとして使用する型を指定します。
[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;
}
}
}
例
説明
次のコード例は、Visual Studio で表示して、DebuggerDisplayAttribute、DebuggerBrowsableAttribute、および DebuggerTypeProxyAttribute の属性を適用した結果を確認できます。
コード
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
関連項目
.NET