nicht angemeldet
Halihallo Forumer
[...]
Vielleicht noch etwas anders ausgedrückt:
- Was haltet ihr von meinem Beispiel? - Ausreichend?
- Was ist besser an dem vorgeschlagenen javadoc?
- Welche Informationen sind relevant für Entwickler, die dem Projekt beigezogen werden?
- Welche Informationen sind für die Endanwender von Relevanz?
- Wie weit sollen Informationen aufgesplittet werden?
z. B. halte ich die Dokumentationen von javadoc für zu "komplex" und dadurch
unübersichtlich, wenn man sie das erste mal zu Gesicht bekommt. Die logische
Strukturierung ist zwar gut, jedoch sind die Funktion und Parameter einer Methode erst
über einen Link zu erreichen und stellt somit eine "Zerstückelung" der Information
dar. Wer das erste mal javadoc-Output liest, ist eventuell etwas überfordert
(zumindest habe ich diese Erfahrung etwas gemacht)
- Wie strukturiert man am besten eine allgemeine Beschreibung oder Beschreibung der
ganzen Komponente, oder einer Klasse?
- Worauf kommt es beim Design an? - Strukturierung, Farben, Inhaltsverweise, TOC,
Ihr könnt ja meine Doku, wie eine Homepage bewerten, falls das Hilft eine
Argumentationsbasis zu finden.
Viele Grüsse
Philipp
PS: Ignoriert mein Englisch, hatte einfach, ohne zu überlegen und korrigieren,
eine Doku genommen und nicht auf Rechtschreibfehler geprüft.