DebuggerDisplay 属性を使用して、デバッガーに何を表示するかを通知する (C#、Visual Basic、F#、C++/CLI)

DebuggerDisplayAttribute は、デバッガー変数ウィンドウでのオブジェクト、プロパティ、フィールドの表示方法を制御します。 この属性は型 (クラス、構造体、列挙型、デリゲート) に適用できますが、通常はクラスと構造体にのみ適用されます。 基本型に適用した場合、サブクラスにも属性が適用されます。

DebuggerDisplay 属性の引数は 1 つです。それは、型のインスタンスの値列に表示する文字列です。 この文字列には、中かっこ ({ と }) を含めることができます。 かっこ内のテキストは、フィールド、プロパティ、メソッドとして評価されます。

クラスにオーバーライドされた ToString() メソッドがある場合、デバッガーは、既定の {<typeName>} の代わりに、オーバーライドされたメソッドを使用します。 したがって、ToString() メソッドをオーバーライドした場合、デバッガーでは、既定の {<typeName>} の代わりに、オーバーライドされたメソッドが使用されます。DebuggerDisplay を使用する必要はありません。 両方を使用した場合、DebuggerDisplay 属性は、オーバーライドされた ToString() メソッドよりも優先されます。 DebuggerDisplay 属性も、サブクラス内のオーバーライドされた ToString() メソッドに優先します。

この暗黙的な ToString() 呼び出しがデバッガーで評価されるかどうかは、 [ツール]、[オプション]、[デバッグ] ダイアログ ボックスのユーザー設定によって異なります。

次の表に、 DebuggerDisplay 属性の使用例と出力例を示します。

DebuggerDisplay には、名前付きパラメーターも使用できます。

autoexp.cs ファイルは、DebuggerDisplay 属性をアセンブリ レベルで使用します。 autoexp.cs ファイルは、Visual Studio が .NET オブジェクトに対して使用する既定の展開を指定します。 DebuggerDisplay 属性の使用方法について autoexp.cs ファイルで確認したり、autoexp.cs ファイルを変更してコンパイルすることで既定の展開を変更したりできます。 変更する場合は、その前に autoexp.cs ファイルのバックアップを作成してください。

autoexp.cs をビルドするには、VS2015 の開発者コマンド プロンプトを開いて、次のコマンドを実行します

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

autoexp.dll への変更は、次のデバッグ セッションで取得されます。

DebuggerDisplay での式の使用

DebuggerDisplay 属性では、中かっこ内で一般的な式を使用できますが、この方法はお勧めしません。

DebuggerDisplay で使用される一般的な式は、対象となる型の現在のインスタンスのみの this ポインターに暗黙的にアクセスします。 この式には、エイリアス、ローカル、またはポインターに対するアクセスはありません。 式からプロパティを参照しても、そのプロパティに関する属性は処理されません。 たとえば、C# コード [DebuggerDisplay("Object {count - 2}")] では、フィールド count が 8 の場合は、Object 6 と表示されます。

DebuggerDisplay で式を使用すると、次のような問題が発生する可能性があります。

• 式の評価はデバッガーで最も負荷のかかる操作であり、式は表示されるたびに評価されます。 これは、コードのステップ実行時にパフォーマンスを低下させる要因になります。 たとえば、コレクションまたは一覧内の値を表示するために使用される複合式は、要素数が多い場合に非常に低速になることがあります。

• 式は、その式が記述された言語の式エバリュエーターではなく、現在のスタック フレームの言語の式エバリュエーターによって評価されます。 これらの言語が異なる場合、予期しない結果が生じる可能性があります。

• 式を評価することにより、アプリケーションの状態が変わる可能性があります。 たとえば、プロパティに値を設定する式は、実行するコード内のプロパティ値を変更します。

  式の評価に関して考えられる問題を回避する方法の 1 つは、操作を実行して文字列を返すプライベート プロパティを作成することです。 これにより、DebuggerDisplay 属性は、そのプライベート プロパティの値を表示できます。 このパターンを実装する例を次に示します。

[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);
        }
    }
}

",nq" サフィックスは、式エバリュエーターに対して、最終的な値を表示するときに引用符を削除するように指示します (nq = no quotes: 引用符なし) 。

例

次のコード例では、 DebuggerDisplayを DebuggerBrowsable および DebuggerTypeProxyと組み合わせて使用する方法を示します。 [ウォッチ] ウィンドウなど、デバッガーの変数ウィンドウに表示されると、次のように展開が作成されます。

[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;
            }
        }
    }
}

関連するコンテンツ

• DebuggerTypeProxy 属性の使用
• .managed オブジェクトのカスタム ビューの作成
• C# の書式指定子
• デバッガー表示属性によるデバッグ機能の拡張