Forderung:
Es müssen gut dokumentierte, übersichtliche und wartbare Programme entwickelt
werden.
Mit der Kodierung darf erst begonnen werden, wenn alle Anforderungen bekannt
und das Konzept dafür erstellt wurde. Dies trifft selbstverständlich nicht in
vollem Umfang auf Prototypen zu, da diese ja gerade dazu dienen, die
Anforderungen zu sammeln und die Konzeption zu erstellen.
Gut dokumentiert
Im Programmkode ist auf folgende Punkte zu achten:
- Verwendung von "sprechenden" Bezeichnern für Klassen,
Variablen, ...
- Einsatz von Headern
in allen Dateien (Beschreibung von Autor, Funktion,
Parameter, ...)
- Kommentierung aller nicht trivialen Abläufe
Übersichtlich, strukturiert
Der erstellte Programmkode ist so zu strukturieren, dass er übersichtlich ist.
Dies hilft zum einen dem Ersteller des Kodes als auch einem anderen Entwickler,
der zu einem späteren Zeitpunkt den Kode bearbeiten muss. Strukturierter
Programmkode wird unter anderem durch eine saubere Klassenhierarchie und durch
das sinnvolle Verwenden von Funktionen erreicht.
Wartbar
Jeder Kode muss wartbar sein. Man kann sich darauf verlassen, dass jeder
"zum Wegwerfen" erstellte Kode trotz dieser Absicht zu einem späteren
Zeitpunkt geändert werden muss. Ein unstrukturiert und undokumentiert
erstellter Kode ist nicht wartbar (mit vertretbarem Aufwand). Daher ist
wartbarer Programmkode unabdingbar.
|
Bei der Arbeit mit sehr leistungsfähigen Entwicklungsumgebungen kann es zu
vollkommen undokumentierten Kodeabschnitten kommen. Leider ist dies dann gerade
jener Kode, der manuell hinzugefügt wurde. Dadurch wird die Wartbarkeit der
Applikation stark vermindert.
Dies entsteht dadurch, dass in den modernen Entwicklungsumgebungen sehr viel
Funktionalität durch "Klicken" definiert werden kann. D.h. es muss
sehr viel weniger Kode manuell erzeugt werden. Dies ist eine sehr erfreuliche
Entwicklung, da dadurch die Arbeitskraft der Entwickler in die konzeptionelle
Phase des Entwicklungsprozesses gelenkt und die Fehlerhäufigkeit (Kodierfehler)
gesenkt werden kann. Leider gibt es neben all diesen Vorteilen auch den
Nachteil, dass der manuell hinzugefügte Kode nicht kommentiert wird (Aussage:
"durch die Entwicklungsumgebung ist alles so selbsterklärend, da braucht
man nicht mehr zu kommentieren"). Gerade der selbst hinzugefügte Kode ist
jedoch im Normalfall nicht trivial (sonst hätte man ihn ja auch
"zusammenklicken" können) und bedarf einer Kommentierung.
|
|