nicht angemeldet
Halihallo Forumer
Ich würde mal gerne eine allgemeine Vorlage für Klassenbeschreibungen erstellen, womit
ich die Klassen schön beschreiben kann. Ich hab da mal was Kleines erstellt, um mir aus
einer XML Datei eine HTML Datei zu transformieren. Jetzt würde ich gerne wissen, was
da noch so alles wichtig für eine Klassenbeschreibung wäre.
Was würdet Ihr euch noch wünschen, wenn Ihr ein solches Dokument vorliegen hättet?
Welche Informationen wären für Euch als Anwender der Komponente noch wichtig?
http://www.emedias.ch/tmp/DatabaseComponent.html mal was für's Auge, dass ihr
etwa wisst, wie ich mir das vorstelle.
Einige Features, die ich noch implementieren möchte, sind:
[x] Beschreibung
[x] Funktionsweise
[x] Anwendungsbeispiele (evtl. für jede Methode?)
[x] Autoren und Kontaktinformation
[x] Beschreibung nicht nur der Methoden, sondern auch der Attribute (Variablen).
[x] Bessere Verlinkung der Klassen (mit Ankern und Links) zu Verdeutlichung der
Funktionsweise.
Was sonst noch? - Ist das vollständig und ausreichend?
Viele Grüsse
Philipp