.NET Tips & Tricks Community RSS

Those who prefer reading this site through RSS now can also subscribe for updates to .NET Tips & Tricks Community.

Use DebuggerBrowsable attribute to clean up class view in a debugger

The DebuggerBrowsable attribute determines if and how a field or property is displayed in the debugger variable windows. Let's review the following code example:

    public class VehicleSeries
    {
        private string _name;
        public string Name
        {
            get { return _name; }
            set { _name = value; }
        }
 
        private List<string> _vehicles = new List<string>();
        public List<string> Vehicles
        {
            get { return _vehicles; }
            set { _vehicles = value; }
        }
    }

The resulting display within the debugger is shown below:

DataTip 1

Now lets remove duplicate information and show constituent vehicles by adding a few DebuggerBrowsable attributes:

    public class VehicleSeries
    {
        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
        private string _name;
        public string Name
        {
            get { return _name; }
            set { _name = value; }
        }
 
        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
        private List<string> _vehicles = new List<string>();
        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
        public List<string> Vehicles
        {
            get { return _vehicles; }
            set { _vehicles = value; }
        }
    }