Code-Dokumentation/ -Erklärung
29.01.2008 13:02:30
Jochen
ich habe einige recht umfangreiche Makros erstellt, die nun von einigen Kollegen verwendet und verändert werden sollen. Dazu möchte ich gerne dokumentieren, warum die einzelnen Codeabschnitte so gestaltet sind, wie sie es sind und dabei auch dokumentieren, welcher Arbeitsprozessschritt hinter den jeweiligen Codeabschnitten steht. Hinterher soll die Kombination aus Code und Erklärung selbsterklärend sein.
Gibt es generell eine Empfehlung, wie man sowas macht?
Mir fällt ein:
* direkt im Code Kommentare schreiben
* Code z.B. in Word kopieren und dort kommentieren
* Ablaufbilder z.B. mit Visio, ppt oder sowas
* eine Kombination aus diesen Teilen?
Wäre super, wenn ich hier von euren Erfahrungen profitieren dürfte!
Vielen Dank für eure Hilfe!
Grüße,
Jo