System.ComponentModel.DescriptionAttribute 这个 Attribute,经常被用来为属性或事件提供说明,这个说明是可以被本地化的。在一些用户界面中,就可以利用这个 Attribute 提供一些额外的信息,就像 Visual Studio 中所做的,如图 1 所示:
图 1 可以看到,对 AutoSizeMode 的说明,被显示在了下面的框中。
但是,界面中的枚举项就没这么好的待遇了,C# 类库中并没有内建对枚举项的 DescriptionAttribute 的支持,就像上面的图所显示的那样,枚举项仍然是英文的。要想提供自己想要的说明,就需要自己来完成。
一、简单的实现
这个功能实现起来其实也很简单,就是通过反射去读取 DescriptionAttribute 的 Description 属性的值,代码如下所示:
/// <summary>
/// 返回枚举项的描述信息。
/// </summary>
/// <param name="value">要获取描述信息的枚举项。</param>
/// <returns>枚举想的描述信息。</returns>
public static string GetDescription(Enum value)
{
Type enumType = value.GetType();
// 获取枚举常数名称。
string name = Enum.GetName(enumType, value);
if (name != null)
{
// 获取枚举字段。
FieldInfo fieldInfo = enumType.GetField(name);
if (fieldInfo != null)
{
// 获取描述的属性。
DescriptionAttribute attr = Attribute.GetCustomAttribute(fieldInfo,
typeof(DescriptionAttribute), false) as DescriptionAttribute;
if (attr != null)
{
return attr.Description;
}
}
}
return null;
}
这段代码还是很容易看懂的,这里取得枚举常数的名称使用的是 Enum.GetName() 而不是 ToString(),因为前者更快,而且对于不是枚举常数的值会返回 null,不用进行额外的反射。
当然,这段代码仅是一个简单的示例,接下来会进行更详细的分析。
二、完整的实现
在给出更加完整的实现之前,先要说说这个 DescriptionAttribute 的问题。
我个人认为,对于枚举来说,这个说明更像是一个可以本地化的、更为友好的别名,而不是一个解释或说明。就拿开头图片里的 AutoSizeMode 这个枚举为例子,我们更希望看到的是“自动扩大或缩小”和“只能扩大”,而不是 MSDN 中的说明那样“控件根据它的内容增大或缩小。 不能手动调整该控件的大小。”和“控件可以根据其内容任意增大,但不会缩小至小于它的 Size 属性值。 窗体可以调整大小,但不能缩小到它所包含的任意控件被隐藏。”
所以,这里更适合的使用 DisplayNameAttribute,而不是 DescriptionAttribute。但可惜的是,DisplayNameAttribute 只能用于类、方法、属性或事件,字段被它无情的抛弃了,因此目前只能拿并不是很合适的 DescriptionAttribute 来凑和了。
吐槽完毕,开始说正事。首先来说,上面的那个函数还是很粗糙的,有很多情况都没有考虑,例如:如果给出的 value 并没有对应一个枚举常数,应该怎么办?
首先参考下 Microsoft 是怎么做的,下面是 Enum.ToString() 的做法&