Book Image

Clean Code in C#

By : Jason Alls
Book Image

Clean Code in C#

By: Jason Alls

Overview of this book

Traditionally associated with developing Windows desktop applications and games, C# is now used in a wide variety of domains, such as web and cloud apps, and has become increasingly popular for mobile development. Despite its extensive coding features, professionals experience problems related to efficiency, scalability, and maintainability because of bad code. Clean Code in C# will help you identify these problems and solve them using coding best practices. The book starts with a comparison of good and bad code, helping you understand the importance of coding standards, principles, and methodologies. You’ll then get to grips with code reviews and their role in improving your code while ensuring that you adhere to industry-recognized coding standards. This C# book covers unit testing, delves into test-driven development, and addresses cross-cutting concerns. You’ll explore good programming practices for objects, data structures, exception handling, and other aspects of writing C# computer programs. Once you’ve studied API design and discovered tools for improving code quality, you’ll look at examples of bad code and understand which coding practices you should avoid. By the end of this clean code book, you’ll have the developed skills you need in order to apply industry-approved coding practices to write clean, readable, extendable, and maintainable C# code.

Related Content you might be interested in

Current Title:

Small book image
Clean Code in C#
Jason Alls
Jul, 2020 | 500 pages
Small book image
High-Performance Programming in C# and .NET
Jason Alls
Jul, 2022 | 660 pages
Small book image
Refactoring in Java
Stefano Violetta
Dec, 2023 | 292 pages
Small book image
Refactoring with C#
Matt Eland
Nov, 2023 | 434 pages
Table of Contents (17 chapters)
Preface
Preface
Who this book is for
What this book covers
To get the most out of this book
Get in touch
1
Coding Standards and Principles in C#
Coding Standards and Principles in C#
Technical requirements
Good code versus bad code
The need for coding standards, principles, and methodologies
Summary
Questions
Further reading
Free Chapter
2
Code Review – Process and Importance
Code Review – Process and Importance
The code review process
Preparing code for review
Leading a code review
Knowing what to review
Knowing when to send code for review
Providing and responding to review feedback
Summary
Questions
Further reading
3
Classes, Objects, and Data Structures
Classes, Objects, and Data Structures
Technical requirements
Organizing classes
A class should have only one responsibility
Commenting for documentation generation
Cohesion and coupling
Design for change
The Law of Demeter
Immutable objects and data structures
Objects should hide data and expose methods
Data structures should expose data and have no methods
Summary
Questions
Further reading
4
Writing Clean Functions
Writing Clean Functions
Understanding functional programming
Keeping methods small
Avoiding duplication
Avoiding multiple parameters
Summary
Questions
Further reading
5
Exception Handling
Exception Handling
Checked and unchecked exceptions
Avoiding NullPointerExceptions
Business rule exceptions
Exceptions should provide meaningful information
Building your own custom exceptions
Summary
Questions
Further reading
6
Unit Testing
Unit Testing
Technical Requirements
Understanding the reasons for a good test
Understanding the testing tools
TDD methodology practice – fail, pass, and refactor
Removing redundant tests, comments, and dead code
Summary
Questions
Further reading
7
End-to-End System Testing
End-to-End System Testing
E2E testing
Factories
Dependency injection
Modularization
Summary
Questions
Further reading
8
Threading and Concurrency
Threading and Concurrency
Understanding the thread life cycle
Adding thread parameters
Using a thread pool
Using a mutex with synchronous threads
Working with parallel threads using semaphores
Limiting the number of processors and threads in the thread pool
Preventing deadlocks
Preventing race conditions
Understanding static constructors and methods
Mutability, immutability, and thread safety
Synchronized method dependencies
Using the Interlocked class
General recommendations
Summary
Questions
Further reading
9
Designing and Developing APIs
Designing and Developing APIs
Technical requirements
What is an API?
API proxies
API design guidelines
API design using RAML
Summary
Questions
Further reading
10
Securing APIs with API Keys and Azure Key Vault
Securing APIs with API Keys and Azure Key Vault
Technical requirements
Undertaking the API project – dividend calendar
Accessing the Morningstar API
Creating the dividend calendar ASP.NET Core web application in Azure
Using an API key to secure our dividend calendar API
Testing our API key security
Adding the dividend calendar code
Throttling our API
Summary
Questions
Further reading
11
Addressing Cross-Cutting Concerns
Addressing Cross-Cutting Concerns
Technical requirements
The decorator pattern
The proxy pattern
AOP with PostSharp
Project – cross-cutting concerns reusable library
Summary
Questions
Further reading
12
Using Tools to Improve Code Quality
Using Tools to Improve Code Quality
Technical requirements
Defining good-quality code
Performing code cleanup and calculating code metrics
Performing code analysis
Using quick actions
Using the JetBrains dotTrace profiler
Using JetBrains ReSharper
Using Telerik JustDecompile
Summary
Questions
Further reading
13
Refactoring C# Code – Identifying Code Smells
Refactoring C# Code – Identifying Code Smells
Technical requirements
Application-level code smells
Class-level code smells
Method-level smells
Summary
Questions
Further reading
14
Refactoring C# Code – Implementing Design Patterns
Refactoring C# Code – Implementing Design Patterns
Technical requirements
Implementing creational design patterns
Implementing structural design patterns
Overview of behavioral design patterns
Final thoughts
Summary
Questions
Further reading
15
Assessments
Chapter 1
Chapter 2
Chapter 3
Chapter 4
Chapter 5
Chapter 6
Chapter 7
Chapter 8
Chapter 9
Chapter 10
Chapter 11
Chapter 12
Chapter 13
Chapter 14
16
Other Books You May Enjoy
Other Books You May Enjoy
Leave a review - let other readers know what you think

API design using RAML

In this section, we will discuss designing an API using RAML. You can gain in-depth knowledge about all aspects of RAML from the RAML website (https://raml.org/developers/design-your-api). We are going to learn the basics of RAML by designing a really simple API using API Workbench in Atom. We'll start with the installation.

The first step is to install the packages.

Installing Atom and API Workbench by MuleSoft

Let's see how to do that:

  1. Start by installing Atom fromhttp://atom.io.
  2. Then, click onInstall a Package:

  1. Then, search forapi-workbench by mulesoftand install it:

  1. The installation is successful if you find it listed underPackages|Installed Packages.

Now that we've installed the packages, let's move onto creating the project.

Creating...

Previous Section
End of Section 6
Next Section