Even bad code can function. But if code isn't clean, it can bring a development organisation to its knees. Every year, countless hours and significant resources are lost because of poorly written code. But it doesn't have to be that way?

In this three-day Clean Code Workshop you will learn the principles and practices of Clean Code as described in Robert C. Martin's book: Clean Code: A Handbook of Agile Software Craftsmanship. You will also receive this book as part of the course materials.

This Clean Code course alternates between lecture and exercise so that you can experience, first-hand, the practices and disciplines of these fundamental topics.

Topics

• Professionalism, Craftsmanship, and Clean Code.
• Choosing Meaningful Names
• Writing Clean Functions
• The Proper Use of Comments
• Coding Style and Formatting
• Object Oriented Programming vs. Procedural Programming.
• Error Handling
• Boundaries between Subsystems
• Unit testing, and Test Driven Development
• Writing Clean Classes
• Systems
• Plan vs. Emergence
• Concurrency
• Smells and Heuristics.

DAY ONE

Clean Code

• There Will Be Code
• Bad Code
• The Total Cost of Owning a Mess
• The Grand Redesign in the Sky
• What is Clean Code?
• A review of expert opinions.
• Schools of Thought
• The Boy Scout Rule

Meaningful Names

• Use Intention Revealing Names
• Avoid Disinformation
• Make Meaningful Distinctions
• Use Pronounceable Names
• Use Searchable Names
• Avoid Encodings
• Avoid Mental Mapping
• Class Names
• Method Names
• Don't be Cute
• One Word per Concept
• No Puns
• Solution Domain Names
• Problem Domain Names

Functions

• Small!
• Do One Thing.
• One Level of Abstraction
• Switch Statements
• Function Names (again).
• Arguments and Parameters
• Side Effects
• Command Query Separation
• Exceptions
• DRY - Don't Repeat Yourself.
• Structured Programming

Comments

• Why and When to Write Comments
• Explain Yourself in Code
• Good Comments
• Bad Comments

Formatting

• The Purpose of Formatting
• Vertical Formatting
• The Newspaper Metaphor
• Horizontal Formatting

Summary


DAY TWO

Objects and Data Structures

• Data Abstraction
• Data/Object Anti-symmetry
• The Law of Demeter
• Data Transfer Objects

Error Handling

• Use Exceptions not Return Codes
• Write your try/catch Statements First
• Use Unchecked Exceptions
• Provide Context with Exceptions
• Define Exception Classes for Callers
• Define Normal Flow
• Don't Return Null
• Don't Pass Null

Boundaries

• Using Third Party Code
• Exploring and Learning Boundaries
• Learning Log4J
• Learning Tests are Better than Free
• Using Code that Does Not Yet Exist
• Clean Boundaries

Unit Tests

• The Three Laws of TDD
• Keeping Tests Clean
• Domain Specific Testing Language
• One Assert
• F.I.R.S.T.

Classes

• Class Organization
• Small Classes
• The Single Responsibility Principles (SRP)
• Maintaining Cohesion
• Organizing for Change

DAY THREE

Systems

• How would you build a city?
• Separation of Construction and Use
• Dependency Injection
• Scaling Up
• Cross Cutting Concerns
• Test Drive the System Architecture
• Optimize Decision Making
• Use Standards Wisely
• System DSLs

Emergence

• Getting Clean via Emergent Design
• Simple Design Rules
• DRY (again)
• Expressiveness
• Minimal Classes and Methods

Concurrency

• Why Concurrency?
• Concurrency Defense Principles
• Know your Library
• Execution Models
• Producer-Consumer
• Readers-Writers
• Dining Philosophers
• Beware Dependencies between Synchronized Methods
• Keep Synchronized Sections Small
• Writing Correct Shut-down Code is Hard
• Testing Threaded Code

Smells and Heuristics

• Dozens and dozens of them.

Conclusion.