nicht angemeldet
Halihallo Simon
Mal eine Frage: Du beziehst Dich objektorientierte Sprachen im Allgemeinen, oder?
Auch wenn ich meistens mit Perl "unterwegs" bin; doch, ja, es soll schon allgemein sein.
Also, hier gibt es ja die UML, mit der sich dann unter anderem auch Dokumentationen von objektorientierten Projekten durchführen lassen.
Stimmt. Jedoch arbeitet UML komplett auf einem "graphischen Level"; das kann ich etwas
schlecht umsetzen. Es müsste schon textuell orientiert sein, wie...
Ansonsten benutze ich, wenn ich in Java schreibe, immer das mitgelieferte JavaDoc (http://java.sun.com/j2se/1.4.1/docs/tooldocs/javadoc/index.html), welches sich auch so erweitern lässt, dass man eigene Layouts produzieren kann. Da ist eigentlich gar nichts anderes mehr nötig. Die Dokumenatation lässt sich bequem als Kommantare in den Quelltext einfügen und es wird alles an Informationen geliefert, was man benötigt.
... das. javadoc ist ein schon sehr gutes Beispiel, wobei ich mich da nicht auf externe
Programme festlegen will; aber der Output (und der interessiert mich) ist schon sehr gut.
Gibt's eigentlich an dem noch etwas zu verbessern (ja, klar, das ist subjektiv
abhängig; aber genau diese subjektive Sicht würde mich interessieren)?
Gibt's noch andere Quellen, welche sich mit Dokumentation "beschäftigen" bzw. solche
enthalten/erstellen? - Vielleicht noch zum Hintergrund meiner Frage: Ich möchte einfach
einmal und dann jedoch auf alle Ewigkeit eine Dokumentationsautomatisierung erstellen
(wie das gepostete Beispiel XML => HTML), sodass ich mir nicht bei jedem Projekt
überlegen muss, wie ich die Doku schreibe, bzw. für jedes Dateiformat eine eigene
produzieren muss. Das soll mal alles automatisiert sein (am besten soll auch gleich das
ganze Programm automatisch programmiert werden *g*). Deshalb wollte ich mich bei euch
erkundigen, was denn so an Ansprüchen an eine Dokumentation gestellt werden; was ist aus
Sicht des Programmierers wichtig, was unwichtig (ja, ich gehöre ja auch dazu, dennoch
wollte ich noch andere Meinungen einholen und mich nicht auf meine verlassen; dann 20
Jahre später bemerken, dass meine Dokus für niemanden zu gebrauchen sind[1]). Deswegen
bin ich im Moment etwas auf der Suche nach "guten Dokumentationen", javadoc ist schon ein
guter Ansatz, danke für den Tipp.
[1] mal vom Inhalt abgesehen, den der sollte ja primär stimmen, natürlich.
Viele Grüsse und Danke
Philipp