Clean C#
Clean C#
Readable, Maintainable, Pleasurable C#
About the Book
This book will help you write cleaner, more maintainable, more readable, and more pleasurable C# code.
About the Author
Table of Contents
-
About The Author
-
Other Leanpub Books by Jason Roberts
- Keeping Software Soft
- C# Tips
- Pluralsight Courses
-
Other Leanpub Books by Jason Roberts
- About this Book
-
Introduction
- What is Clean C#?
- Why Clean C#?
-
Using this Book
- Code Samples
- Order
- Prescriptive
- Clean C# is a Spectrum
-
Comments
- Repeating What the Code Already Says
- Change Control Comments
- Comments as a Substitute for Self Documenting Code
- Commented-Out Code
- Pointless XML Documentation Comments
- Acceptable Use of Comments
-
Naming Things
-
Qualities of Clean Names
- Expressive
- Accurate
- Suitable Length
- Pronounceable Names
-
Naming Specific Items
- Namespaces
- Interfaces
- Classes
- Methods
- Properties
- Events
- Fields
- Attributes
- Method Parameters
- Variables
- Booleans
- Generic Types Parameters
- Enums
- Some General Rules
-
Qualities of Clean Names
-
Methods
- Method Size and Clarity
- Cohesive Methods
- Mixing Abstraction Levels
- Action or Answering Methods
-
Method Parameters
- Methods with Zero Parameters
- Methods with One Parameter
- Methods with Two Parameters
- Methods with Three Parameters
- Methods with More Than Three Parameters
- Refactoring to Reduce the Number of Parameters
- Params
- Output Parameters
- Named Arguments
- Boolean Switching Arguments
- Multiple Returns
- Code Duplication in Methods
- Methods with Side Effects
-
Structuring Programs for Readability
- Levels of Abstraction
- Method Level Abstractions
-
Errors and Exceptions
- Returning Error Codes
-
Using Exceptions
- Supplied Framework Exceptions
- Defining Custom Exceptions
-
Alternatives to Error Codes, Exceptions, and Returning Nulls
- Try Methods
- Special Case Design Pattern
-
Visual Formatting
- The Principle of Proximity
- The Principal of Similarity
- The Principal of Uniform Connectedness
- The Principal of Symmetry
-
Cohesion and Coupling
- Cohesion
- Coupling
-
Clean Tests
-
Qualities of Good Test
- Execution Speed
- Independent and Isolated
- Repeatable and Reliable
- Valuable
- Resilient to Production Code Changes
-
The Three Logical Phases of Tests
- The Arrange Phase
- The Act Phase
- The Assert Phase
- How Many Asserts?
- Simplifying Arrange Phase code with AutoFixture
-
Qualities of Good Test
-
Building On Clean Code
- The Single Responsibility Principle (SRP)
- The Open Closed Principle (OCP)
- The Liskov Substitution Principle (LSP)
- The Interface Segregation Principle (ISP)
- Keep It Simple Stupid (KISS)
- Don’t Repeat Yourself (DRY)
- You Aren’t Gonna Need It (YAGNI)
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$10,891,199writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Functional event-driven architecture: Powered by Scala 3
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way, mainly powered by Fs2 streams in Scala 3!
Leverage your functional programming skills by designing and writing stateless microservices that scale, powered by stateful message brokers.
- #2
Practical FP in Scala: A hands-on approach
Gabriel VolpeA practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
- #3
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #4
Book of Monads
Alejandro Serrano MenaIn functional programming, at the heart of input/output, failure, state, logic, and much more, lies a powerful abstraction called monad. This book provides a journey from the very first concepts, to the myriad of monads available to programmers, down to the categorical foundations.
- #5
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #6
入門 日本語自然言語処理
Masato Hagiwara and Paul O'Leary McCann日本語テキストを処理したい全てのプログラマ・エンジニアの方へ。分かち書きなどの基本から、自然言語生成などの最新の話題までをカバー。動かして学べるコードや、参照文献も付いています。言語学や機械学習の知識が無くても問題ありません。
- #7
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #8
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
- #9
Introduction to Japanese Natural Language Processing
Masato Hagiwara and Paul O'Leary McCannA thorough guide for programmers working with Japanese text, covering fundamental issues like tokenization and recent research topics like generating natural language texts. Working examples are accompanied by extensive reference to allow problem solving even without a background in Japanese or Machine Learning.
- #10
Cloud Strategy
Gregor Hohpe“Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud can transform your organization, but it shouldn’t be driven by wishes. This book tells you how to develop a sound strategy guided by frameworks and decision models without being overly abstract nor getting lost in product details.
Top Bundles
- #1
Modern C++ Collection
3 Books
Get All about Modern C++C++ Standard Library, including C++20Concurrency with Modern C++, including C++20C++20Each book has about 200 complete code examples. Updates are included. When I update one of the books, you immediately get the updated bundle. You can expect significant updates to each new C++ standard (C++23, C++26, .. ) and also... - #2
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #3
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #4
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #6
Abandon Your Job - Leaving the Rat Race with Python
8 Books
Now, get all the great Python and Freelancing books from finxter.com in one single bundle!Coffee Break Python - All Python BasicsCoffee Break Python Workbook - Practice the basics of PythonCoffee Break Python Mastery Workouts - Practice advanced Python conceptsCoffee Break Python Slicing - All about SlicingCoffee Break Python NumPy - Get started... - #8
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes! - #10
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible...
