Fehlerbehandlung, Dokumentation und Qualitätskontrolle - JavaScript: Die Universelle Sprache zur Web-Programmierung - page 131

dumm“ 4 . Das ist kein Widerspruch zu einer intelligenten Programmierung - im Gegenteil.
Denn intelligent bedeutet in der Programmierung einfach und langweilig . Und damit ist die
Erstellung von dem Code erst einmal wenig fehlerträchtig, aber der Code ist auch leichter
wartbar, was mittel- bis langfristig genauso wichtig ist. Einfach bedeutet, dass Sie nicht
unnötig komplexe oder lange Strukturen schreiben sollten. Lieber schreiben Sie zwei kurze
Funktionen als eine lange Funktion. Und man sollte sich in Quellcodes nicht wiederholen.
Was Sie also schon einmal geschrieben haben, sollten Sie nicht noch ein weiteres Mal neu
kodieren, sondern benutzen. Und wie gesagt, ist langweilige Programmierung fast immer
gut. Doch was soll das bedeuten? Als recht leicht merkbare Regel können Sie sich merken,
dass Sie immer so programmieren sollten, dass sich jemand Fremdes 5 über Ihren Code
nicht wundern würde. Erwartbare Strukturen sind gut, unerwartete Strukturen schlecht.
Wenn Sie etwa an einer Stelle eine while -Schleife verwenden und in einer vergleichbaren
folgenden Situation eine for -Schleife, dann ist das unerwartet und schlecht, wenn es keinen
unvermeidbaren Grund gibt. Ein erfahrener Programmierer, der den Code sieht, würde sich
fragen, warum einmal die eine Schleife und das andere Mal die andere Schleife verwendet
wurde? Und dies vollkommen überlüssig, wenn es eben keinen zwingend Grund gibt. Oder
wenn Sie einmal eine Konstante vollkommen groß schreiben und das andere Mal nur den
ersten Buchstaben groß schreiben, ist das unerwartet und damit schlecht (was wieder auf
die Konventionen zurückkommt).
6.2.7■Kommentare und Dokumentation
Nutzen Sie weiter beim Erstellen Ihrer Quellcodes ausführlich Kommentare, die Sie an den
unterschiedlichsten Stellen im Quelltext notieren. Erstens erleichtert es die spätere War-
tung und zweitens machen Sie sich beim Ausformulieren eines Kommentars noch einmal
Gedanken über die Quelltextstruktur. Dabei fallen ot auch Fehler auf.
Wobei das Thema Kommentierung nicht ganz unumstritten ist. Ich habe auch Meinungen
von erfahrenen Programmierern gelesen, dass man als professioneller Programmierer so
gut wie keine Kommentare in den Quellcode schreiben soll. Die Argumentation lief so, dass
ein Quellcode durch sprechende Bezeichner und einfache Strukturen selbst erklärend sein
soll (siehe weiter vorn). Aber das ist meines Erachtens Wunschdenken und nur bei äußers-
ter Programmierdisziplin möglich. Ebenso setzt es erhebliche Erfahrung voraus. Gerade am
Anfang sind deshalb Kommentare unabdingbar. Ebenso ist es wichtig für eine spätere Wei-
terentwicklung und Wartung, dass Sie eine sorgfältige Dokumentation Ihrer Projekte füh-
ren. Darin gehören die vorbereitenden Dokumente wie Ablaufdiagramme und Anforde-
rungsproile, aber auch die Beschreibungen der tatsächlichen Codestrukturen.
HInWEIS: Wir werden in dem Kapitel noch die automatische Erstellung von
Dokumentationen aus speziellen Kommentaren sehen (siehe Abschnitt 6.4.1).
4 Es gibt verschiedene Analogien, wofür KISS steht - auch für „Halte es einfach, Dummkopf“. Aber die Aussage ist
immer gleich.
5 Oder auch Sie selbst, wenn Sie den Code nach langer Zeit wieder ansehen.