Code-Doku

[marabu]

Hallo Leo,

es scheint sich nicht um ein "Produkt" zu handeln, sondern um eine Programmierarbeit "im Auftrag". Wenn der Quellcode die wesentliche Leistung darstellt und eine weitere Bearbeitung das eigentliche Interesse des Kunden ist, dann spielen Pflichten- und Lastenheft (Anwendungsqualität) keine Rolle, sondern eher quellenbezogene Qualitäten.

Zu dem was schon geschrieben wurde: Verpasse jeder Funktion eine Beschreibung. Dazu gehören Parameter (Anzahl, Wertebereiche), Rückgabewerte, Benutzungsbeziehungen (wo wird die Funktion aufgerufen, was wird von der Funktion augfgerufen), welche globalen Variablen werden benutzt. Das gleiche für jede Unit: Benutzungsbeziehungen, Reihenfolge der Einbindung, Interface. Ein Verzeichnis aller Konstanten, Typen, Klassen und globalen Variablen wird gebraucht, am besten immer mit Querbezügen.

Das ist immer noch nicht alles, aber hält dich schon in Trab. Wenn es sich um eine Anwendung handelt, dann fehlen auf jeden Fall betriebsbezogene Informationen: FileSystem-Layout, Installation, Deinstallation, Konfiguration, Migration, Datensicherungskonzept, Benutzerverwaltung.

Es gibt Werkzeuge, die dir einen Teil der Arbeit abnehmen können. Ich höre hier mal auf.

Grüße vom marabu