Ansätze moderner Softwaredokumentation
Bei der Entwicklungsarbeit legen wir Wert auf die saubere Dokumentation des Programm-Quellcodes. Die Bezeichner von Variablen, Klassen und Methoden sind selbsterklärend. Die Struktur wird durch geeignetes Ein- und Ausrücken von Kontrollstrukturen hinreichend deutlich.
Kommentierung des Quellcodes
Die Dokumentation wird so weit wie möglich in den Quellcode eingearbeitet. Dies geschieht durch Kommentarzeilen, die in unmittelbarer Nähe der entsprechenden Anweisungen im Quellcode stehen und die bei einer Veränderung der Anweisungen umgehend aktualisiert werden.
Ergänzung der Kommentierung
Soweit Anmerkungen, Skizzen und dergleichen nicht direkt in den Quellcode integriert werden können, werden sie separat abgelegt und gemeinsam mit den Quellcode-Dateien verteilt, damit sie allen Entwicklern zur Verfügung stehen und es nicht zu Inkonsistenzen kommt.