FAQ-Frage: Nach welchen Richtlinien erstellen Sie Codebeispiele?

Ich verwende auf Basis meiner Erfahrung und auf Basis von Leser-Feedback folgende Richtlinien zu den Programmcodebeispielen in diesem Buch:

Die Beispiele sollen möglichst autonom sein, d.h. ein abgedrucktes Listing soll alle notwendigen Elemente enthalten, auch wenn dies auf Kosten der Wiederverwendung von Programmcode geht.
Alle notwendigen Konfigurationsinformationen (z.B. Computernamen, Verbindungszeichenfolgen) sollen Teil des Listings sein, auch wenn dies dazu führt, dass diese Daten im Quelltext statt in einer Konfigurationsdatei abgelegt werden.
Beispiele sollen dann nicht autonom sein, wenn es explizit darum geht, die Wiederverwendbarkeit von Programmcode, die Nutzung von Konfigurationsdateien oder eine gute Softwarearchitektur darzustel-len.
Die Variablennamen in den Codebeispielen sollen einfach sein. Kurznamen, die nur aus einem oder zwei Buchstaben stehen, sind entgegen den üblichen Gepflogenheiten erlaubt, um Platz zu sparen und Zeilenumbrüche in abgedruckten Listings zu vermeiden (dies erhöht die Lesbarkeit von Listings in ei-nem Buch!)
Bei allen Codebeispielen steht die Funktionalität im Vordergrund, nicht die Gestaltung der Ein- und Ausgabe.

Weitere Informationen