c-sharp

c-sharp Best Practices

This document outlines the definitive C# coding standards and best practices for our team. Adhering to these guidelines ensures consistency, readability, maintainability, and high performance across all our C# projects.

Code Organization and Structure

1. Naming Conventions

Always follow standard .NET naming conventions to improve readability and predictability.

• Types (Classes, Structs, Enums, Delegates, Records): PascalCase
• Interfaces: IPascalCase
• Methods, Public Properties, Events: PascalCase
• Public Constants: PascalCase
• Local Variables, Method Parameters: camelCase
• Private/Protected Fields: _camelCase (underscore prefix)
• Async Methods: PascalCase ending with Async

❌ BAD:

public class myService {
    private string name;
    public void getdata() { /* ... */ }
    public async Task do_work() { /* ... */ }
    public interface IMyServiceImplementation { /* ... */ } // Incorrect interface naming
}

✅ GOOD:

public class MyService {
    private readonly ILogger _logger; // Readonly private fields
    private string _name;
    public const int MaxRetries = 3; // Public constants are PascalCase

    public MyService(ILogger logger) {
        _logger = logger;
    }

    public void GetData() { /* ... */ }
    public async Task DoWorkAsync() { /* ... */ }
}
public interface IService { /* ... */ } // Correct interface naming

2. Formatting

Always maintain consistent code layout for clarity.

• Indentation: Use 4 spaces. Configure your IDE to use spaces, not tabs.
• Braces: Use Allman style where each brace begins on a new line. Always use braces, even for single-statement blocks.
• using Directives: Place at the top of the file, outside the namespace. Sort alphabetically, with System namespaces first.
• Auto-properties: Keep on a single line.
• Generic Constraints: Place on separate, indented lines.