C#调试与测试 | DebuggerDisplay使用技巧

DebuggerDisplay使用技巧

前言

当你在开发一个大型的应用程序时，调试是一个不可避免的任务。调试器是你的好朋友，但是有时候它并不能直接给你所需的信息。这时，就需要使用 C# 中一个很有用的 Attribute：DebuggerDisplay。

关于Attribute
Attribute 是 C# 中一种特殊的类，它可以在编译时为类、方法、属性等元素添加元数据。在运行时，这些元数据可以被反射机制使用。它是一种很强大的元编程工具，可以让你在运行时获取更多的信息。

DebuggerDisplay介绍

DebuggerDisplay可以让你在调试器中显示你自己定义的字符串，代替默认的显示方式。换句话说，它可以让你在调试器中更加方便地查看对象的信息。

当你在调试一个复杂的对象时，往往会发现默认的显示方式不能满足你的需求。这时，你可以使用 DebuggerDisplay 来自定义你想要显示的信息。例如，你可以将一些比较重要的属性或字段的值显示在调试器中，这样你就可以更加方便地了解对象的状态。另外，如果你使用了一些自定义的类，这些类可能没有默认的 ToString 方法，调试器默认的显示方式就会非常简陋，这时你可以使用 DebuggerDisplay 来定义一个更加友好的显示方式。

示例代码

接下来我们用一个示例代码演示如何使用 DebuggerDisplay。

首先我们定义了一个 Person 类，并给它添加了 DebuggerDisplay Attribute。

[DebuggerDisplay("Name = {Name}, Age = {Age}")]
class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

在Main方法中实例化一个Person 对象，并将其输出到控制台。

class Program
{
    static void Main(string[] args)
    {
        var person = new Person { Name = "张三", Age = 20 };
        Console.WriteLine(person); // 在这里添加一个断点
    }
}

由于我们定义了 DebuggerDisplay Attribute，调试器会显示我们自己定义的字符串，即 “Name = 张三, Age = 20”。这样，我们就可以更加方便地了解 Person 对象的状态了。