CleanCode

Table of Contents

Introduction

(…) the natural entropy of systems is towards a ball of mud. – DHH

Values

Clarity

Elegance

Do

Express your thoughts clearly

Naming conventions

  • Usage
  • Purpose
  • Consequences

Unit tests

Dave [Thomas] is right. Code without tests, is not clean. No matter how elegant it is, no matter how readable and accessible, if it hath not tests, it be unclean.

(Robert C. Martin, Clean Code, p. 9)

Small functions

  • functions should serve only one single purpose
  • they should be easily and quickly understandable

Coding standards

  • should be consistent across the project
  • consitent naming scheme
  • see Checkstyle
  • should following the usual coventions of the respective language

Don't do

Tools

GitHubImpressum