重载ToString让调试变的更加方便

C#中一切皆源于Object，而且默认会有ToString函数的实现。有时为了更方便的输出，我们会重载ToString函数。其实ToString不仅可以方便输出，也可以帮助我们调试。我们来看看未重载ToString和重载ToString的差别，效果图如下

在未重载ToString函数时，在调试时s1显示的是系统默认的ToString函数，即显示对象的类型。而我们调试时，往往是为了看看该对象里面的数据。为了能看到数据，我们必须将其展开才能看到，也就是属性Name、Age、Sex。而如果我们实现了ToString函数后，直接就能看到。

下面是Staff类的实现代码

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace WindowsFormsApplication13
{
    public class Staff
    {
        #region 属性
        private String _name;
        /// <summary>
        /// 名字
        /// </summary>
        public String Name
        {
            get { return _name; }
            set { _name = value; }
        }

        private int _sex;
        /// <summary>
        /// 性别
        /// </summary>
        public int Sex
        {
            get { return _sex; }
            set { _sex = value; }
        }


        private int _age;
        /// <summary>
        /// 年龄
        /// </summary>
        public int Age
        {
            get { return _age; }
            set { _age = value; }
        }

        #endregion

        public Staff()
        {

        }

        public Staff(String name, int sex, int age)
        {
            Name = name;
            Sex = sex;
            Age = age;
        }

        public override string ToString()
        {
            //return base.ToString();
            return String.Format("{0},{1},{2}岁", Name, Sex == 1 ? "男" : "女", Age);
        }
    }
}

当对象的层级很多的时候，这种效果会更加明显。比如我们在Staff之上再加一层叫Company的类，代码如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace WindowsFormsApplication13
{
    public class Company
    {
        #region 属性
        private Staff _manager;
        /// <summary>
        /// 经理
        /// </summary>
        public Staff Manager
        {
            get { return _manager; }
            set { _manager = value; }
        }

        private Staff _engineer;
        /// <summary>
        /// 工程师
        /// </summary>
        public Staff Engineer
        {
            get { return _engineer; }
            set { _engineer = value; }
        }

        private Staff _designer;
        /// <summary>
        /// 设计师
        /// </summary>
        public Staff Designer
        {
            get { return _designer; }
            set { _designer = value; }
        }        
        #endregion

        public override string ToString()
        {
            //return base.ToString();
            return String.Format("经理:{0},工程师:{1},设计师:{2}", Manager, Engineer, Designer);
        }
    }
}

来看看未重载ToString和重载ToString的差别。

我们会看到，在未重载前，为了看到设计师的名字必须从c1中展开，再从Designer中展开，然后查看里面的Name属性。而重载了ToString之后，点开c1就能看的到。

有时，为了在不同的配置模式下进行调试，我们还可以在ToString重载的时候，再加入一些模式的判断，比如Debug和Release模式，将Company的ToString函数修改如下

   public override string ToString()
        {
            //return base.ToString();
#if DEBUG
            return String.Format("DEBUG--经理:{0},工程师:{1},设计师:{2}", Manager, Engineer, Designer);
#else
            return String.Format("RELEASE--经理:{0}", Manager, Engineer, Designer);
#endif
        }

来看看效果图

可以看到在Debug和Release模式下看到了不同的数据，有的项目中会有更多的配置方式，那ToString就可以做更多的变换和处理，至于如何使用就看实际需要了。