Hinweise zur Kommentierung
Die Kommentare sollen dem inhaltlichen Verständnis der Programmlogik dienen. Sie sollen nicht Grundlagen der Programmiersprache beschreiben! Beispiel:
Gut: index:=index+1; {Fachindex auf nächsten Satz}
Schlecht: index:=index+1; {Variable index um eins erhöhen}
Es soll also der Hintergrund der Anweisung, nicht die Anweisung selbst, allgemeinverständlich beschrieben werden.
Namensgebung von Bezeichnern
Als Faustregel gilt: Die Länge eines Bezeichners soll proportional zu seinem Sichtbarkeitsbereich sein.
Für eine lokale Schleife darf die Laufvariable durchaus "i" heißen,
für ein umfangreicheres Modul sollte eine relevante Variable jedoch einen
aussagefähigeren Namen, wie z.B. "PersonalNr" erhalten. Zusätzlich ist bei der Deklaration ein Kurzkommentar zum
Einsatzzweck der Variablen vorzusehen.
Programmtest
Zur Beschreibung eines Programmtests gehört eine Auflistung der Testeingabedaten, der erwarteten und der errechneten Ergebnisdaten.
Bei Abweichungen sind Begründungen anzugeben und das Programm entsprechend zu beurteilen (z.B. "Eine Ungenauigkeit von 0.005 % ergibt sich aus dem numerischen Darstellungsbereich des Datentyps XYZ und ist
f7uuml;r die erwarteten Werte vertretbar.").
Grundlage der Auswahl der Testdaten ist der WHITE-BOX-Test, der gewährleistet,
daß alle Programmteile durchlaufen werden.
Die Auswahl der verwendeten Testdaten ist zu begründen, z.B. Indexwerte 99, 100 und 101, um bei einem Array von 100 Werten die
Grenzüberschreitung zu prüfen.
Die Aufführung der errechneten Ergebnisdaten sollte, mindestens teilweise, in Form von Hardcopys erfolgen.
Aufbau von Protokolltabellen
Die nachfolgenden Tabellen sind als Beispiel für einen möglichen Aufbau gedacht und nicht als festgelegte Formulare. Sie sind je nach Bedarf abzuwandeln bzw. zu
ergänzen.
Modulschnittstellentabelle
Tabelle wurde mit Netscape Navigator Tags erstellt