Kurzer Bezug auf Klassen?

[Ludas]

Hi,

das ein UML-Diagramm in die Doku gehört ist meiner Meinung nach klar. Nun habe ich in einigen Dokus gesehen, das alle Klassen in Form einer Tabelle kurz beschrieben werden.

Ist das eurer Meinung nach nen richtiger Ansatz? Und gilt sowas auch für Models und Controller? Denn ich denke UserController oder so sagt eigentlich schon aus worum es in etwa geht?

Models würde ich ganz raus lassen, stellen Sie doch doch eigentlich nur Daten bereit. Aus welchen Quellen diese Stammen interessiert doch niemanden so sehr das er dafür eine Tabelle bräuchte oder?

Was denkt ihr?

[Akku]

Mit Sicherheit bekommst du kein Punktabzug, wenn du die Klassen nicht in einer Tabelle beschreibst. UML sollte schon reichen. Zum Thema MVC: Erstelle doch eine richtig schöne Grafik, aus der ersichtlich wird, was die einzelnen Komponenten so machen. Du weißt schon: Persistens und so;)

[LadyPreis]

Ich bin grad an meiner Doku und werde es wahrscheinlich auch mit Tabellen machen.

Habe mir einige interne Dokumentationen angeschaut und da scheint es eine beliebte Darstellung zu sein. Zumal eine Tabelle auch gut für jemanden zu lesen ist, der keine Kentnisse in UML vorweisen kann

[Ludas]

Ich werde es mir noch einmal überlegen, mit Sicherheit aber nicht auf UML verzichten, da sich die Relationen deutlich besser darstellen lassen.