Rouven: Dokumentationen verfassen

Beitrag lesen

Hi,

wenn du als Beispiel das JDK (also die Java-Dokumentation) nimmst, dafür gibt es im JDK ein kleines Konsolenprogramm, dem gibst du den Pfad zu deinen Quelltexten an und dann erstellt er daraus eine Funktionsreferenz. Da gibt es dann noch so kleine technische Feinheiten wie Kommentare die mit ** anfangen und irgendwelche Tags, so dass man seinen Quellcode bereits so kommentiert, dass dieser Interpreter hinterher was damit anfangen kann und das nimmt er dann alles in seine Hilfe mit auf, Resultat sind dann Autoreninformationen, Parameterinformationen und solche Sachen.
Ist eine recht faszinierende Sache.

MfG
Rouven

--

-------------------
ss:) zu:) ls:& fo:) de:< va:{ ch:? sh:) n4:( rl:? br:$ js:| ie:) fl:(