C# Framework Standards · CS-04

For instance, use object instead of Object, string instead of String, and int instead of Int32. These aliases have been introduced to make the primitive types a first class citizen of the C# language so use them accordingly.

Roslyn Analyzer Rule SA1121

The guidelines in this topic apply to localisable resources such as error messages and menu text.

• Use Pascal casing in resource keys.
• Provide descriptive rather than short identifiers. Keep them concise where possible, but don’t sacrifice readability.
• Use only alphanumeric characters in naming resources.

Examples include connection strings, server addresses, etc.

In ASP.NET Core, use IConfiguration from the Microsoft.Extensions.Configuration packages to access data in code, and store the actual values in appsettings.json files, user secrets, environment variables, Azure Configuration, Azure Key Vault, etc.

In ASP.NET, use the ConfigurationManager class and its AppSettings and ConnectionStrings properties. Maintain the actual values in app.config or web.config files.

Configure the development environment to use Warning Level 4 for the C# compiler, and enable the option Treat warnings as errors. This allows the compiler to enforce the highest possible code quality.

Roslyn Analyzer Rule AV2210

The dynamic keyword has been introduced for working with dynamic languages. Using it introduces a serious performance bottleneck because the compiler has to generate some complex Reflection code.

Use it only for calling methods or members of a dynamically created instance (using the Activator) class as an alternative to Type.GetProperty() and Type.GetMethod(), or for working with COM Interop types.

Roslyn Analyzer Rule AV2230

Using the new C# 5.0 keywords results in code that can still be read sequentially and also improves maintainability a lot, even if you need to chain multiple asynchronous operations. For example, rather than defining your method like this:

public Task<Data> GetDataAsync()
{
    return MyWebService.FetchDataAsync()
                       .ContinueWith(t => new Data (t.Result));
}

Define it like this:

public async Task<Data> GetDataAsync()
{
    var result = await MyWebService.FetchDataAsync();

    return new Data (result);
}

Roslyn Analyzer Rule AV2235