C# Enum Usage Record

Enumeration is to name and classify some sets of constants. Taking the example of life as a week is a kind of enumeration.

If there is such a fixed set that needs to be used frequently, it can be implemented by enumeration in the program. In addition to being easy to manage, if you want to use a string as a key in a program, you can clearly know the purpose, and there will be no trouble with capitalization or spelling mistakes.

If there is no preset corresponding number, the value is given in order
Veiw = 0
Add = 1
Edit = 2...

C#
public enum LogBehavior
    {
        Veiw, Add, Edit, Delete, Search, Login, Send
    }

or

C#
public enum Month
    {
        Jan = 1, Feb = 2, Mar = 3, Apr = 4, May = 5, Jun = 6, 
        Jul = 7, Aug = 8, Sep = 9, Oct = 10, Nov = 11, Dec = 12
    }

The way to get enum parameters

C#
Console.WriteLine(LogBehavior.Veiw);
>>  Veiw

Console.WriteLine(LogBehavior.Veiw.GetHashCode());
>>  0

string month = Month.Jan.ToString(); 
Console.WriteLine(month);
>> Jan

int monthValue = (int)Month.Jan;  
Console.WriteLine(monthValue);
>> 1

The backend needs to add an extensibility object to each returned API(List<dynamic>), you can add objects according to the situation, but you need to add specific parameters that let front-end know properties of the objects.

It can be easily managed by using enumeration. If you want to return the specific parameter name of the object, other people can directly use it. There will be no artificial string misspelling or capitalization errors. You can also directly add extensions if you need other specific parameters later.

C#
public enum prop
{
    [Description("Synchronize record information")]
    SyncInfo,
    [Description("Version information")]
    VersionInfo
}

If you want to get the content of Description, you can use this method to expand, if there is no content of Description, will return the original name.

C#
public static string GetDescription(this Enum value)
    {
        var field = value.GetType().GetField(value.ToString());
        var attribute = field?.GetCustomAttributes(typeof(DescriptionAttribute), false).FirstOrDefault() as DescriptionAttribute;
        return attribute == null ? value.ToString() : attribute.Description;
    }

C#
Console.WriteLine(prop.SyncInfo.GetDescription());
>> Synchronize record information

References
Extension Methods
C# enum 列舉 同時儲存內容值和中文說明 教學

Csharp

Alvin

Software engineer, interested in financial knowledge, health concepts, psychology, independent travel, and system design.

ASP.NET Core API & Blazor Implements Caching Mechanism to Improve Performance

ASP.NET Core Blazor Basic Concepts and Hosting Models Selection (Server vs WebAssembly)

Image Lazy Loading in ASP.NET Core Blazor

Operating Amazon S3 with ASP.NET Core Web API and Blazor

Implementing Multilingual Support in ASP.NET Core Blazor

Performing MongoDB Atlas CRUD Operations with .NET 6