Experience is the hardest kind of teacher.
It gives you the test first and the lesson afterward.
-Susan Ruth
Das Prinzip der geringsten Überraschung
Heuristik
Um den Nutzer einer Software nicht zu verwirren, sollten Sie ungewohnte oder überraschende Dinge in Ihrem Code vermeiden.
Erklärung
Denken Sie beim Schreiben Ihres Quellcodes an dessen Nutzer. Versuchen Sie die Dinge verständlich und einfach zu tun. Halten Sie sich dabei an die folgenden Grundsätze:
Einfachheit: Entwerfen Sie einfache Klassen und Methoden. Wählen Sie die einfachste Lösung, die funktioniert.
Klarheit: Stellen Sie sicher, dass jede Klasse, jede Schnittstelle, jede Methode, jed Variable und jedes Objekt einen klaren Zweck erfüllt. Erklären Sie, warum, wann und wie jedes Element zu verwenden ist.
Vollständigkeit: Stellen Sie ein Minimum an abgeschlossener Funktionalität bereit. Achten Sie auf eine vollständige Quellcode-Dokumenation.
Konsistenz: Gleiche Dinge sollten gleich aussehen und sich gleich verhalten. Definieren Sie Standards und halten Sie sich daran.
Robustheit: Stellen Sie vorhersehbares und dokumentiertes Verhalten zur Verfügung. Programmieren Sie defensiv.
Experience is the hardest kind of teacher.