DebuggerDisplay 属性の使用

DebuggerDisplay 属性 (System.Diagnostics.DebuggerDisplayAttribute) は、デバッガーの変数ウィンドウでクラスやフィールドを表示する方法を制御します。この属性は次の対象に適用できます。

  • クラス

  • 構造体

  • デリゲート

  • 列挙型

  • フィールド

  • プロパティ

  • アセンブリ

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

C# オブジェクトにオーバーライドされた ToString() がある場合、デバッガーはそのオーバーライドを呼び出し、標準の {<typeName>} ではなく、その結果を表示します。したがって、オーバーライドされた ToString() がある場合、DebuggerDisplay を使用する必要はありません。両方を使用すると、DebuggerDisplay 属性が ToString() オーバーライドよりも優先されます。

この暗黙的な ToString() 呼び出しがデバッガーで評価されるかどうかは、[オプション] ダイアログ ボックス ([全般] ページの [デバッグ] カテゴリ) のユーザー設定に応じて変わります。Visual Basic には、この暗黙的な ToString() 評価は実装されていません。

重要 : 重要

[ツール オプション] ダイアログ ボックスの [オブジェクトの生の構造体を変数ウィンドウに表示する] チェック ボックスがオンになっている場合、DebuggerDisplay 属性は無視されます。

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

属性

[値] 列に表示される出力

[DebuggerDisplay("x = {x} y = {y}")]

x フィールドと y フィールドがある型で使用されます。

x = 5 y = 18

[DebuggerDisplay("String value is {getString()}")]パラメーターの構文は、言語によって異なります。そのため、使用には注意が必要です。

String value is [5, 6, 6]

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

パラメーター

目的

Name, Type

このパラメーターは、変数ウィンドウの [名前] 列と [型] 列に影響があります (よりコンストラクターと同じ構文を使用する文字列を設定できます)。これらのパラメータを増えに使用することにより、間違って使用するには、複雑な生産物が発生する場合があります。

Target, TargetTypeName

属性がアセンブリ レベルで使用される場合に、対象の型を指定します。

[!メモ]

autoexp.cs ファイルは、DebuggerDisplay 属性をアセンブリ レベルで使用します。autoexp.cs ファイルは、Visual Studio が C# 変数に対して使用する既定の展開を指定します。DebuggerDisplay 属性の使用方法などについて autoexp.cs ファイルで確認したり、autoexp.cs ファイルを変更してコンパイルすることで既定の展開を変更したりできます。変更する場合は、その前に autoexp.cs ファイルのバックアップを作成してください。\Program Files\Microsoft Visual Studio 11.0\Common7\IDE\PublicAssemblies の Microsoft.VisualStudio.DebuggerVisualizers.dll を参照する必要があります。autoexp.cs ファイルは、My Documents/Visual Studio 2012/Visualizers にあります。

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

使用例

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

名前

価値

Key

"three"

object {string}

価値

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

参照

関連項目

DebuggerTypeProxy 属性の使用

概念

カスタム データ型の表示

デバッガー表示属性によるデバッグ機能の拡張