Generieren der Technischen Doku aus dem Code
Rainer Hirthammer
Workshop (-> HLP) Technische Dokus aus der Code-Kommentierung zu
erzeugen (Modul-, Prozeduren-, Schnittstellen- etc. Beschreibungen).
Nur ist das Vorgehen recht ungwampert und erfordert für alle im Team
einiges an Eingewöhnung. Kennt jemand bessere Alternativen?
Danke, Rainer
Klaus Büttner
Hallo,
natürlich soll ein solches Werkzeug möglichst viel automatisch
erledigen, indem es z.B. über einen CodeParser (ohne weitere Tags) ein
Grundgerüst einer technischen Doku aus dem source-code erzeugen kann.
Der Informationsgehalt einer solchen automatisch parsierten Doku
steigt naturgemäß an wenn zusätzliche Infos herangezogen werden
können. Verfolgt man den Anspruch, Source und Doku nicht per se
auseinanderlaufen zu lassen, so ist es ein verbreiteter Ansatz die
Doku direkt im Source-code zu pflegen. Dabei bieten sich Tags (XML ??)
eigentlich geradezu an. Wenn dann noch die Ausgabe des Doku-Werkzeugs
im XML-Format erfolgt, ist eine Darstellung in chm, htm, etc.... über
XSL(T) (sehr) leicht möglich.
Ums schreiben von mehr oder weniger Text kommt man allerdings auch bei
einem Werkzeug mit Parser nicht drumherum, soll denn die Doku nicht
gar zu dünn sein.
Wir setzen ein (selbstgewerkeltes) Werkzeug zur
Dokumentationserstellung ein, dass a) über einen VB-Codeparser verfügt
und damit alles was möglich ist auch automatisch in die Doku
übernimmt, b) Modulköpfe und Kommentare in XML-Syntax (aber nicht nur)
scannen und übernehmen kann und c) das ganze im XML-Format ausgibt.
Entsprechende XSLT-Scripte setzen dies dann in das gewünschte Layout
und/oder Format um.
Vergleichbar ist das in etwa mit der Möglichkeit automatische Dokus in
Java oder in C# zu erstellen.
Falls Du an weitern Infos interessiert bist, dann melde Dich (auch per
mail).
Grüße
Klaus Büttner
henning.brueggemann
anderem auch xml-Dokumentation des Quellcodes erstellen aknn. Vielleich
hilft das?
--
Mit freundlichem Gruß,
------------------------------------------
Henning Brüggemann
------------------------------------------
------------------------------------------
"Klaus Büttner" <Klaus.B...@sos-berlin.com> schrieb im Newsbeitrag
news:ad3067f2.03020...@posting.google.com...