Programmdoku aus dem Quellcode generieren

Programmdoku aus dem Quellcode generieren

hallo zusamen,

das Thema Programmdokumentation wird ja oft stiefmütterlich behandelt. In unserer Firma werden Programme in einem internen Wiki dokumentiert, was mich daran stört ist, dass man die Doku zwei mal schreiben muss. Das erste Mal hängt man eine (oft recht kurze) Beschreibung an die Funktionen, Module und ggf. Formeln, anschliessend tut man es noch mal etwas ausführlicher in dem Wiki. Das Ziel wäre aus dem ABAP-Quellcode (ich gehe erstmal nur von einfachen Reports aus) die Doku automatisch generieren zu lassen. In internet findet man Lösungen wie z.B. Natural Docs bzw. Doxygen, aus der Beschreibung konnte ich aber nicht entnehmen, dass es auch für ABAP nutzbar wäre. Hat jemand Erfahrung mit einer solchen Software bzw. Anregungen was das Thema angeht?

Re: Programmdoku aus dem Quellcode generieren

Hallo Thomas,

danke für die Anmerkung. Wie bereits beschrieben wird es ja bei uns so ähnlich gemacht. Je länger ich darüber nachdenke, umso unwahrscheinlicher scheint es mir, dass ich das Vorhaben umsetzen, sprich aus dem ABAP-Code eine vollständige Dokumentation generieren kann. Im Programm selbst haben die Kommentare ja eher technischen Charakter. In dem Wiki sammeln sich wiederum Erklärungen, Bilder und Hinweise auf bestimmte Fehler und Besonderheiten, die sich oft erst im Produktivbetrieb ergeben. Wenn ich jetzt versuchen würde das mit dem Quellcode synchron zu halten, so komme ich vor lauter Transportieren zu nichts anderem mehr...

Re: Programmdoku aus dem Quellcode generieren

Hallo Jens,

das Wiki das wir einsetzen (PmWiki) hat keine Datenbank, da wird jede Seite in Form einer Textdatei abgelegt. Man könnte die Wiki-Seite sicherlich initial aus SAP erzeugen lassen. Wie aber bereits weiter oben diskutiert würden die Inhalte im Wiki sehr schnell mit denen aus dem ABAP auseinander laufen.