Wie kann ich die Lesbarkeit von Enums durch die Verwendung benutzerdefinierter Beschreibungen verbessern?

Erhöhung der Enum-Lesbarkeit: Verwendung benutzerdefinierter Beschreibungen

In einer früheren Diskussion ging es um die Zuweisung beschreibender Namen zu Enum-Werten. Zur Erläuterung:

Während die Beispiel-Enumeration Werte mit Leerzeichen und Punkten enthält, müssen Enum-Namen bestimmten Namenskonventionen folgen – normalerweise einzelne Wörter ohne Satzzeichen oder Leerzeichen.

Für benutzerfreundlichere Enum-Werte nutzen Sie das Attribut Description. Mit diesem Attribut können Sie jedem Enum-Mitglied eine beschreibende Zeichenfolge hinzufügen und so die Klarheit des Codes erheblich verbessern.

Hier ist eine hilfreiche Erweiterungsmethode, um diese Beschreibungen einfach abzurufen:

public static string GetDescription(this Enum value)
{
    Type type = value.GetType();
    string name = Enum.GetName(type, value);
    if (name != null)
    {
        FieldInfo field = type.GetField(name);
        if (field != null)
        {
            DescriptionAttribute attr = 
                   Attribute.GetCustomAttribute(field, 
                     typeof(DescriptionAttribute)) as DescriptionAttribute;
            if (attr != null)
            {
                return attr.Description;
            }
        }
    }
    return null;
}

Diese Methode vereinfacht den Zugriff auf die Beschreibung eines beliebigen Enum-Werts. Siehe das Beispiel unten:

public enum MyEnum
{
    [Description("Description for Foo")]
    Foo,
    [Description("Description for Bar")]
    Bar
}

MyEnum x = MyEnum.Foo;
string description = x.GetDescription();

Das obige ist der detaillierte Inhalt vonWie kann ich die Lesbarkeit von Enums durch die Verwendung benutzerdefinierter Beschreibungen verbessern?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!