讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么获取枚举的描述_C#如何读取Enum的Description属性【技巧】

酷浩君_3060

酷浩君_3060

发布时间:2026-03-30 17:09:55

|

568人浏览过

|

来源于php中文网

原创

用GetCustomAttribute()从MemberInfo获取Description值,需先通过typeof(Enum).GetMember("Name")[0]获取成员元数据,再调用泛型方法提取,空值需判空处理。

c#怎么获取枚举的描述_c#如何读取enum的description属性【技巧】

怎么用 GetCustomAttribute 读取 DescriptionAttribute

枚举值的描述信息是通过 DescriptionAttribute 声明的,C# 本身不提供直接获取方法,必须手动反射提取。核心就是调用 GetCustomAttribute,但要注意它返回的是 object,得显式转型。

  • 先用 typeof(MyEnum).GetMember("ValueName") 拿到成员元数据,不能直接对枚举值调用 —— 那会报错:ArgumentException: Object does not match target type
  • GetCustomAttribute<descriptionattribute>()</descriptionattribute> 是泛型安全写法,比非泛型版本少一次强制转换
  • 如果没加 DescriptionAttribute,返回 null,别直接调 .Description,否则 NullReferenceException

示例:

var member = typeof(Status).GetMember(nameof(Status.Pending))[0];
var attr = member.GetCustomAttribute<DescriptionAttribute>();
string desc = attr?.Description ?? nameof(Status.Pending);

为什么 ToString() 和 GetName() 都拿不到 Description

ToString() 返回的是枚举字段名(如 "Pending"),Enum.GetName() 也一样 —— 它们压根不查自定义属性。Description 是额外附加的元数据,和名称、值完全解耦。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 哪怕你把枚举值写成 Pending = 1,Description 写成 "待处理",ToString() 依然输出 "Pending"
  • 有人误以为加了 [Description("xxx")] 后,枚举值就“变成”那个字符串,其实只是多挂了个标签,不影响任何默认行为
  • 这个设计是故意的:保证枚举语义清晰(字段名代表程序逻辑),Description 只用于展示层,职责分离

封装成扩展方法时,GetValue() 和 GetMember() 的选择差异

常见封装是给 Enum 类型加个 GetDescription() 扩展。关键分歧点在于:传入的是枚举值(如 Status.Pending)还是字符串名(如 "Pending")?

  • 如果参数是枚举值(TEnum value),必须用 value.ToString() 得到字段名,再调 typeof(TEnum).GetMember(...) —— 因为 GetCustomAttribute 只能从 MemberInfo 上取
  • 别试图对 value 直接调 GetCustomAttribute,编译都过不去:Enum 类型没有该方法
  • 性能上几乎无差别,.NET Core 6+ 对 GetMember 做了缓存,但频繁调用仍建议自己缓存 MemberInfo 映射表(尤其在循环里)

中文描述乱码或显示为空?检查编译器和运行时行为

不是代码问题,而是 IDE 或调试器显示机制导致的假象。实际运行时只要字符串字面量正确,就不会出错。

  • VS 调试窗口里看到的是 DescriptionAttribute 构造函数参数的原始字符串,中文没问题;但如果在 WPF 的 ComboBox 里显示为空,大概率是绑定路径写错了,比如绑成了 Item.Description 而不是调用了你的扩展方法
  • .NET Framework 和 .NET 5+ 行为一致,但旧版 Mono 可能不支持泛型 GetCustomAttribute<t></t>,得回退到非泛型 + as 转换
  • 发布为 ReadyToRun 时,反射仍可用,但若启用了 IL trimming(如 <publishtrimmed>true</publishtrimmed>),需在 csproj 中保留 DescriptionAttribute:<trimmerrootassembly include="System.ComponentModel"></trimmerrootassembly>

最常被忽略的是:Description 属性只在类库或可执行项目中生效,如果你把它定义在某个 NuGet 包里,而主项目没引用 System.ComponentModel,编译期不会报错,但运行时 GetCustomAttribute 总返回 null —— 因为类型加载失败静默吞掉了异常。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3709

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2468

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1400

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1358

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1436

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2398

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3980

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

18915

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn