Nice Code Cheat-Sheet
Im Nice Code Valley gibt es nicht viele Regeln. ABER: Die “22 Gebote” müssen bei uns im Schlaf beherrscht werden.
- STR + ALT + L (Code → Reformat Code) ist dein Freund.
- Eine Methode ohne Annotations ist einsam.
- Eine (öffentliche) Methode ohne Unit Test ist für den Anwender wie ein Sprung ins kalte Wasser.
- Deine Kollegen freuen sich über aussagekräftige Klassen-, Methoden- und Parameter-Namen.
- Bei komplexeren Methoden darf auch gerne kommentiert werden.
- Jedes Code Inspection Problem schwerer als “Typo” ist bei neu geschriebenem Code zu vermeiden.
- Unit Tests sollten nur den im Testfall betroffenen Code testen und soweit wie möglich von anderen Codes unabhängig sein (Mock mal wieder).
- Hat ein Mock in einem Testfall Enkelkinder (Mock vom Mock vom Mock) schreit das nach einem Refactoring des getesteten Codes.
- Vor Aufgabenwechsel, dem köstlichen Mittagessen oder dem kühlen Feierabendbier ist immer ein Commit mit lauffähigem Entwicklungsstand zu pushen!
- Git mag keinen unversionierten Code-Commit, Commit, Commit (und Push)!
- Jede Teillösung zu einer Aufgabenstellung ist ein Commit.
- Sollte dein Arbeitsgerät das Zeitliche segnen, sollte nicht mehr als eine Bildschirmseite Codezeilen verloren gehen. Ansonsten schreit das nach einem Commit (und Push).
- Eine Woche ohne Pair Programming ist nur im Urlaub oder bei Ausgangssperren akzeptabel.
- Es gibt keine blöden Fragen, nur blöde Antworten!
- Statische Methoden kann man nicht bzw. nur eingeschränkt Unit testen!
- Eine Klasse hat keine öffentlichen Eigenschaften; nur Getter und Setter!
- Dieselben Funktionalitäten in unterschiedlichen Klassen schreien nach einem gemeinsamen Interface. Ein passendes Trait hilft dabei gerne bei der Implementierung in einer Klasse.
- Jede fehlerhafte Anwendung einer Methode ist eine Exception und sollte nicht unterdrückt oder kaschiert werden. Solche Fehler sind dann sehr scheu und kaum zu erwischen – Exceptions sind laut und leicht zu fangen!
- Ein Bug, Problem, Feature, Aufgabe – oder was auch immer – ohne Ticket gibt es nicht!
- Hast du schon den Zeitaufwand für den letzten Commit im Ticket gebucht?
- Vier Augen sehen mehr als zwei
- Kein Pushen in den Hauptzweig zu folgenden Zeitpunkten: Freitag vor dem Wochenende, letzter Tag vor dem Urlaub, Tag vor einem Feiertag oder ähnliches.
Wenn du unsere 22 Gebote beherrschst, Teil eines hochmotivierten Team werden und vom bestmöglichen Arbeitsklima umgeben sein möchtest, kannst du dich schon mal bereit machen deine Koffer zu packen, um ein Teil des Nice Code Valley zu werden.
