CW 14: Documentation

[system]

Ich bin mir nicht ganz sicher, was wir diese Woche abgeben sollen

Disclaimer: Dieser Thread wurde aus dem alten Forum importiert. Daher werden eventuell nicht alle Formatierungen richtig angezeigt. Der ursprüngliche Thread beginnt im zweiten Post dieses Threads.

[user10]

CW 14: Documentation
Ich bin mir nicht ganz sicher, die Hausaufgabe richtig verstanden zu haben…

Wir sollen verschiedenste Sachen dokumentieren, soweit ist alles verständlich, nur wo wir das machen sollen verstehe ich nicht ganz. Sollen wir viele Kommentare dem Code hinzufügen, oder lassen wir den Code diese Woche quasi unberührt und erstellen ein PDF-Dokument? Und ist in diesem Fall eine “Dokumentation” sowie das “eigentliche” Hausaufgaben-PDF abzugeben, oder wirddiese Woche nur ein einzelnes PDF abgegeben?

Herzlichen Dank schon einmal im Voraus!

[Dirk_Riehle]

---

The homework due next week, CW #14 is

Trace and document the instantiation process of both

• your photo class and
• your domain class

For each class, document

• the sequence of method calls that lead to the new object
• Start with the call to your object manager or, if none, your factory

For each class, document

• the object creation solution as a point in the solution space
• Use the object creation table (i.e. you should provide a six tuple)

So, first document the process. That’s stepping through the code if you will, and you can document it any way you like. Many choose prose (method calls), some choose UML (sequence diagrams or others). Obviously, don’t go down to the level of the VM but stay within the code of the application. No need to touch the code itself.

Then apply the conceptual framework from class as to what form of object creation that is and / or happens along the way.

One PDF, as usual.