PDA

View Full Version : [Frage] source code doku

Chuck
02-05-2004, 21:34
hoi
wie genau muss eigentlich die dokumentation des quellcodes sein?
ich bin nämlich leider ein notorischer nicht dokumentierer und würd deshalb gern wissen was so als das minimum angesehen wird :shinner:
carmofin
03-05-2004, 00:31
gleiches problem hier... wir haben jetzt drei tage wie irre durchgecodet und sind froh wenn wir überhaupt fertig werden, wo jetzt wieder die doku herkommen soll weiß ich ned ;) ich kann nur hoffen dass das nicht zu viel zeit in anspruch nimmt!
ChrisChiu
03-05-2004, 01:07
Die folgenden Links haben Informationen, wie wir uns die Dokumentation vorstellen:

http://www.cg.tuwien.ac.at/courses/CG23/Organisation.html
http://www.cg.tuwien.ac.at/courses/CG23/Aufgabe2.html

Es ist also definitiv nicht gefragt, jede einzelne Kleinigkeit zu dokumentieren. Die Dokumentation soll gerade so detailliert sein, dass wir die Sachen, von denen ihr meint, dass sie besondere Beachtung verdienen :D, auch finden (also Antworten zu Fragen wie "Welche Objekte wurden wie beleuchtet (Angabe der Lichtquellen mit Typ) bzw. texturiert?" und ähnliches).
MarianSchedenig
03-05-2004, 03:16
Hmm. Wir haben die Anforderungen so verstanden, daß diese Dinge in extra Dokumenten beschrieben werden (haben wir im RTF/PDF-Format).

Die Doxygen-Kommentare sind bei uns nur bei den älteren Programmteilen vorhanden (dort dafür recht gut, bis auf die Teile, die geändert worden, dort stimmen die Docs nicht mehr ;)), die neueren Passagen sind teilweise noch so provisorisch, daß sie mit Kommentaren und Debug-Ausgaben vollgestopft sind...unsere Physikengine beginnt gerade erst, halbwegs physikalisch zu wirken.
cypher
04-05-2004, 00:33
Hmm. Wir haben die Anforderungen so verstanden, daß diese Dinge in extra Dokumenten beschrieben werden (haben wir im RTF/PDF-Format).


naja, zumindest folgende informationen sollten einfach in einer readme.txt drin sein:

- Eure Namen, MatNr., eMail
- wie startet man das Spiel
- worum geht's
- wie bedient man das Spiel
- kurze zusammenfassung des storyboards

das sollte eigentlich nicht mehr als 20 Minuten brauchen, das bekommt also glaub ich jeder noch hin :)