Book Image

Refactoring with C#

By : Matt Eland
5 (1)
Book Image

Refactoring with C#

5 (1)
By: Matt Eland

Overview of this book

Software projects start as brand-new greenfield projects, but invariably become muddied in technical debt far sooner than you’d expect. In Refactoring with C#, you'll explore what technical debt is and how it arises before walking through the process of safely refactoring C# code using modern tooling in Visual Studio and more recent C# language features using C# 12 and .NET 8. This book will guide you through the process of refactoring safely through advanced unit testing with XUnit and libraries like Moq, Snapper, and Scientist .NET. You'll explore maintainable code through SOLID principles and defensive coding techniques made possible in newer versions of C#. You'll also find out how to run code analysis and write custom Roslyn analyzers to detect and resolve issues unique to your code. The nature of coding is changing, and you'll explore how to use AI with the GitHub Copilot Chat to refactor, test, document, and generate code before ending with a discussion about communicating technical debt to leadership and getting organizational buy-in to refactor your code in enterprise organizations and in agile teams. By the end of this book, you'll understand the nature of refactoring and see how you can safely, effectively, and repeatably pay down the technical debt in your application while adding value to your business.
Table of Contents (24 chapters)
Free Chapter
1
Part 1: Refactoring with C# in Visual Studio
7
Part 2: Refactoring Safely
13
Part 3: Advanced Refactoring with AI and Code Analysis
18
Part 4: Refactoring in the Enterprise

Building a Roslyn Analyzer code fix

Roslyn Analyzers allow you to provide options for users to automatically fix issues your analyzers detect in your code. They do this through something called a code fix provider, which can modify your document in an automated manner to resolve the diagnostic warning.

Think of it this way: diagnostic analyzers, like our OverrideToStringAnalyzer, help detect issues in your team’s code. On the other hand, code fix providers give you a way of fixing these issues.

Not all diagnostic analyzers will have code-fix providers, but in my experience, those that also provide code-fix providers tend to get addressed earlier and more consistently.

Let’s see how one works.

Creating a CodeFixProvider

First, we’ll add a new class to the Packt.Analyzers class library. We’ll call this class ToStringCodeFix. Replace its contents with the following code for a basic code fix:

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis...