CleanCode

Clean Code Development

Hierbei handelt es sich um bewährte Prinzipien und Praktiken aus der objektorientierten Softwareentwicklung. Sie wurden von und aus verkürzt übernommen. Ein reflektiertes Verwenden dieser Richtlinien kann zu besserem und vor allem lesbarerem Quellcode führen.

Prinzipien

Don't repeat yourself (DRY)

Kopierter Code leistet Inkonsistenzen Vorschub und führt zu einem mehr an Fehleranfälligkeit und Arbeit. Kein Copy & Paste sondern den gemeinsamen Code in Funktionen auslagern.

Keep it simple, stupid (KISS)

Unnötige Komplexität ist Zeitverschwendung. Einfach ist gut.

Beware of Optimizations

Optimierung bedeutet Aufwand und in der Regel auch komplexeren Code. Solange es nicht WIRKLICH notwendig ist, sollte man auf solche Methoden verzichten.

Single responsibility Principle (SRP)

Eine Klasse sollte genau eine Aufgabe erfüllen. Das fördert die Lesbarkeit und Übersicht.

Code Conventions

Unverzichtbar bei Zusammenarbeit mehrerer Entwickler an einem größeren Softwareprojekt. Erhöht die Lesbarkeit und sorgt für Konsistenz im Quellcode.

Information Hiding Principle

Eine Klasse sollte nur die für die Schnittstelle notwendigen Methoden und Felder öffentlich zur Verfügung stellen. Durch das Verbergen der Implementierungsdetails wird die Benutzung der Klasse von diesen unabhängig gemacht.

Principle of least astonishment

Programmteile sollten sich so verhalten, "wie man es erwartet". Funktionen sollten sich ihrem Namen entsprechend Verhalten und Seiteneffekte sollten klar ersichtlich und gut dokumentiert sein.

Tell, don't ask

Eine Klasse sollten nicht von aussen über ihren internen Zustand befragt werden können. Es ist besser dem Objekt mitzuteilen was es zu tun hat. Das verlagert die Logik zur Benutzung der Klasse in die Klasse selbst und der Benutzer muss sich darüber keine Gedanken mehr machen.

Law of Demeter (Don't talk to strangers)

Lange Abhängigkeitsketten zwischen den Klassen eines Projekts führen zu einer engen Kopplung. Das Law of Demeter schlägt vor, dass eine Methode nur folgende andere Methoden verwendet

• Methoden der eigenen Klasse
• Methoden der Parameter
• Methoden assozierter Klassen
• Methoden selbst erzeugter Objekte

You ain't gonna need it (YAGNI)

Was man nicht braucht sollte man nicht programmieren.

Praktiken

Code lesen

Lesen ist eine der besten Übungen überhaupt und bringt neue Erfahrungen ohne den Aufwand des Schreibens.

Versionierung

Systeme wie Subversion (svn) erlauben verteiltes Arbeiten mit zusätzlichem Rückgriff auf alte Versionen des Projekts.

Scout Rule

Wenn der Quellcode immer Stück sauberer verlassen wird als man ihn vorgefunden hat, verbessert er sich iterativ.

Root cause Analysis

Nicht die Symptome sondern die Ursache bekämpfen. Debugging Regel Nummer 1.