Modern C# 12: Refactoring with Primary Constructors and XML Docs

C# development has seen substantial changes with the release of .NET 8 and C# 12, streamlining dependency injection through a new feature called Primary Constructors. This evolution has simplified the creation of dependency-injected classes, eliminating the need for lengthy boilerplate code. Historically, developers had to declare private read-only fields, define an explicit constructor, and assign each parameter manually, leading to cumbersome code and difficulties in maintaining domain and service classes.

With C# 12's primary constructors, developers can now declare parameters directly within the class definition, streamlining the process while maintaining clarity and type safety.

In legacy C# code before the advent of primary constructors, a payment processing service class necessitated numerous lines to set up dependencies. The class was annotated with XML documentation tags to provide clarity on parameters, such as the primary payment provider and the audit logging service. Despite the effectiveness of this approach, it was often verbose and required significant boilerplate code.

With the introduction of primary constructors in C# 12, the PaymentProcessor class underwent a significant transformation. The class now declares dependencies directly in its definition, eliminating the need for a separate constructor and parameter assignment. This not only reduces code clutter but also enhances readability and understanding of the class's dependencies at a glance.

The integration of these modern features with .NET Analyzers and EditorConfig ensures uniformity across development teams. By configuring static analysis rules in the .editorconfig file, developers are prompted to refactor toward primary constructors, maintaining a consistent coding style. Furthermore, automated documentation tools, such as the Code Formatter & Auto-Doc AI, parse primary constructor parameters to generate necessary XML documentation tags.

This automation guarantees compliance with coding standards, such as StyleCop (SA1600), and aligns with official Microsoft guidelines, all without manual intervention.

The adoption of primary constructors in C# 12 thus represents a paradigm shift towards cleaner, more efficient, and maintainable codebases. By reducing boilerplate, improving code clarity, and automating documentation processes, developers can focus more on business logic rather than cumbersome setup procedures. This modern approach not only aligns with best practices but also enhances the overall quality and readability of C# applications.