如何為我的 C# 枚舉添加友好名稱和描述？

利用描述屬性增強枚舉：賦予枚舉更清晰的含義

在程式設計領域，枚舉 (enumeration) 是一種強大的工具，用來表示一組不同的值。然而，為枚舉值賦予更有意義的名稱往往是一個挑戰。讓我們深入探討這個問題及其可能的解決方案。

追求友善的名字

為枚舉值賦予使用者友善的名稱的需求源自於程式碼清晰性和可讀性的需要。如下例所示：

<code class="language-c#">public enum myEnum
{
    ThisNameWorks, 
    This Name doesn't work,
    Neither.does.this
}</code>

透過這種方法，很難辨別枚舉值背後的預期意義。相反，我們需要一種方法來定義枚舉，其名稱更明確地表達其用途。

使用Description屬性解鎖描述

幸運的是，C# 提供了一個優雅的解決方案：DescriptionAttribute 屬性。透過將此屬性套用至枚舉字段，您可以為每個值關聯自訂描述。方法如下：

<code class="language-c#">[Description("Foo的描述")]
Foo,
[Description("Bar的描述")]
Bar</code>

使用提供的擴充方法，您可以在執行時檢索這些描述：

<code class="language-c#">public static string GetDescription(this Enum value)
{
    // ... 实现代码在此处
}</code>

<code class="language-c#">MyEnum x = MyEnum.Foo;
string description = x.GetDescription();</code>

透過這種改進的方法，枚舉現在不僅包含原始值，還包含有意義的描述，這有助於理解和維護您的程式碼庫。採用友善的枚舉，提高程式碼可讀性，增強開發體驗。

以上是如何為我的 C# 枚舉添加友好名稱和描述？的詳細內容。更多資訊請關注PHP中文網其他相關文章！