Zitat:
Wenn es darum geht das sich andere Entwickler zurechtfinden dann empfehle ich die Dokumentation im Quellcode !
Ntürlich könnte ich im Quellcode dokumentieren, klingt auch durchaus sehr sinnvoll, allerdings wollte ich die Dokumentation schon gerne gesondert verfassen, d.h. in soetwas wie einem "Handbuch".
Der Grund ist, dass ich zwar auch möglicherweise mal ein anderer Entwickler in dem Code zurecht finden soll, aber es geht mir auch zu einem großen Teil darum, meine Arbeit zu dokuemtieren, da ich das Programm dann auch abgeben werde.
Zitat:
Stelle dir mal zuerst die frage, was du selber von einer "dokumentation" erwartest. Beispiele gibt es in jedem handbuch.
Die Frage habe ich mir natürlich auch schon gestellt, allerdings ist es natürlich immer schwierig sich zu überlgen, was man erwartet, wenn man noch gar keine Erfahrungen in diesem Themengebiet hat.
Was wäre denn z.B. ein Handbuch, in dem ich dazu nährere Informationen finden könnte?
Zitat:
ABER: Ein anderer Entwickler lernt am besten aus Beispielen.
Das klingt logisch. Beispiele könnten natürlich auch in meiner Dokumentation eine wichtige Rolle Spielen. Ebenso wie der suaber strukturierte Quelltext, das scheint mir natürlich die Grundlage des Ganzen zu sein.
Gibt es denn z.B. so etwas wie Gundregeln, z.B. was dokumentiere ich eigentlich, was nicht? Oder was muss ich genauer erläutern und was ist selbsterklärend?
Gruß