使用 DebuggerDisplay 特性

更新：2011 年 5 月

本主题适用于：

版本	Visual Basic	C#	F#	C++	Web Developer
学习版
专业版、高级专业版和旗舰版

DebuggerDisplay 特性 (System.Diagnostics.DebuggerDisplayAttribute) 控制类或字段在调试器变量窗口中的显示方式。 此特性可应用于：

• 类

• 结构

• 委托

• 枚举

• 字段

• 属性

• 程序集

DebuggerDisplay 特性有一个参数，此参数是要在值列中显示的表示类型实例的字符串。 此字符串可以包含大括号（{ 和 }）。 一对大括号之间的文本将作为字段、属性或方法来计算。

如果 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# 变量的默认扩展。 可以检查 autoexp.cs 文件以获得如何使用 DebuggerDisplay 特性的示例，或者可以修改和编译 autoexp.cs 文件以更改默认扩展。 在修改 autoexp.cs 文件之前一定要对它进行备份。 必须引用 \Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PublicAssemblies 中的 Microsoft.VisualStudio.DebuggerVisualizers.dll。 可以在 My Documents/Visual Studio 10.0/Visualizers 中找到 autoexp.cs 文件。

在 DebuggerDisplay 中使用表达式

虽然您可以在 DebuggerDisplay 特性中的大括号之间使用常规表达式，但建议不要这样做。

DebuggerDisplay 中的常规表达式只能隐式访问目标类型当前实例的 this 指针。 不能访问别名、局部变量或指针。 如果表达式引用属性，则不处理这些属性上的特性。 例如，C# 代码 [DebuggerDisplay("Object {count - 2}" 中如果该字段 count 是8将显示 Object 6。

在 DebuggerDisplay 中使用表达式可能导致以下问题：

• 计算表达式在调试中试是最消耗资源的操作，并且表达式在每次显示时都会被计算。 在单步执行代码中，这可能导致性能问题。 例如，一个用来在集合或列表中显示值的复杂表达式，在元素的数量很大时可能很慢。

• 表达式是通过当前堆栈帧的语言表达式计算器计算的，而不是通过表达式记录语言的计算器计算的。 使用不同的语言时，可能导致不可预知的结果。

• 计算表达式可以更改应用程序的状态。 例如，设置属性值的表达式在执行代码时改变属性值。

减少表达式计算可能出现的问题的一种方法是创建执行操作和返回字符串的私有属性。 然后 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); }
    }
}

示例

下面的代码示例演示如何使用 DebuggerDisplay 以及 DebuggerBrowseable 和 DebuggerTypeProxy。 在调试器变量窗口（如**“监视”**窗口）中查看时，它生成类似以下内容的扩展：

Name	值	Type
键	"three"	对象 {string}
值	3	对象 {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 特性

概念

显示自定义数据类型

使用调试器显示特性增强调试

修订记录

Date	修订记录	原因
2011 年 5 月	添加了有关在属性值中使用表达式的警告。	信息补充。