Hi,
der Titel sagt ja schon das Meiste. Ich arbeite gerade als Werksstudent an einem Projekt, bei dem ich der einzige Programmierer bin (ca. 4000 Zeilen Code, also noch überschaubar). Die Anforderungen und Ziele sind recht klar gestellt.
Nur bei der Dokumentation gibt es keinerlei Anforderungen. Ich würde aber gerne eine erstellen, hauptsächlich um dabei etwas zu lernen.
Jetzt gehen die Meinungen im Internet & der Literatur allerdings sehr weit auseinander. Manche lehnen externe Dokumente komplett ab und befürworten einzig die Dokumentation per Kommentaren. Andere sehen UML-Diagramme, Modulübersichten etc.
als elementar an.
Mir geht es dabei weniger um eine Bedienungsanleitung, sondern um die Lesbarkeit des Codes.
Wie handhabt ihr das so?
*Topic verschoben*
der Titel sagt ja schon das Meiste. Ich arbeite gerade als Werksstudent an einem Projekt, bei dem ich der einzige Programmierer bin (ca. 4000 Zeilen Code, also noch überschaubar). Die Anforderungen und Ziele sind recht klar gestellt.
Nur bei der Dokumentation gibt es keinerlei Anforderungen. Ich würde aber gerne eine erstellen, hauptsächlich um dabei etwas zu lernen.
Jetzt gehen die Meinungen im Internet & der Literatur allerdings sehr weit auseinander. Manche lehnen externe Dokumente komplett ab und befürworten einzig die Dokumentation per Kommentaren. Andere sehen UML-Diagramme, Modulübersichten etc.
als elementar an.
Mir geht es dabei weniger um eine Bedienungsanleitung, sondern um die Lesbarkeit des Codes.
Wie handhabt ihr das so?
*Topic verschoben*
Option strict = on
If it's stupid and it works it ain't stupid.
If it's stupid and it works it ain't stupid.
Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Marcus Gräfe“ ()