Programmdoku aus dem Quellcode generieren
6 Beiträge
•
Seite 1 von 1
6 Beiträge
Seite 1 von 1
Beitrag
von Alexander D. (Expert / 682 / 30 /
84
)
»
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?
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?
schöne Grüße
Alexander
ECC 6.0 EHP 7
Alexander
ECC 6.0 EHP 7
gesponsert ⓘ
Stellenangebote auf ABAPforum.com schalten
kostenfrei für Ausbildungsberufe und Werksstudenten
kostenfrei für Ausbildungsberufe und Werksstudenten
Hallo Alexander,
zu dem Thema "Automatische Generierung von Dokumentation" kann ich nichts sagen,
aber zum Thema "2x dokumentieren".
Bei uns wird im Wiki dokumentiert und in der SAP-Hilfe ein Link ins Wiki gesetzt.
MfG
Thomas R.
zu dem Thema "Automatische Generierung von Dokumentation" kann ich nichts sagen,
aber zum Thema "2x dokumentieren".
Bei uns wird im Wiki dokumentiert und in der SAP-Hilfe ein Link ins Wiki gesetzt.
MfG
Thomas R.
Beitrag
von Alexander D. (Expert / 682 / 30 /
84
)
»
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...
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...
Zuletzt geändert von Alexander D. am 25.09.2012 09:15, insgesamt 1-mal geändert.
schöne Grüße
Alexander
ECC 6.0 EHP 7
Alexander
ECC 6.0 EHP 7
Moin Alexander,
ich habe zum Zweck der Dokumentation ein Report geschrieben, der eine WORD Vorlage "ausfüllt" und unter der Ticketnummer speichert.
Inhaltlich wird, außer dem Inhalt des Transportauftrags, ggf. das Coding, bzw. die Veränderungen gespeichert.
Desweiteren Namen der "Importeure" und der aktuelle Transportstatus.
Wenn Ihr alles in einem Wiki ablegt, würde ich via HTTP die Doku DIREKT auf die Datenbank des Wiki's ablegen. Das funktioniert, sofern SAP, via HTTP, Zugriff auf den Server hat.
gruß Jens
Ist das Wiki von MediaWiki.org ?
ich habe zum Zweck der Dokumentation ein Report geschrieben, der eine WORD Vorlage "ausfüllt" und unter der Ticketnummer speichert.
Inhaltlich wird, außer dem Inhalt des Transportauftrags, ggf. das Coding, bzw. die Veränderungen gespeichert.
Desweiteren Namen der "Importeure" und der aktuelle Transportstatus.
Wenn Ihr alles in einem Wiki ablegt, würde ich via HTTP die Doku DIREKT auf die Datenbank des Wiki's ablegen. Das funktioniert, sofern SAP, via HTTP, Zugriff auf den Server hat.
gruß Jens
Ist das Wiki von MediaWiki.org ?
<:: XING-Gruppe Tricktresor::>
Die deutsche Rechtschreibung ist Freeware, du darfst sie kostenlos nutzen –
Aber sie ist nicht Open Source, d. h. du darfst sie nicht verändern oder in veränderter Form veröffentlichen.
Die deutsche Rechtschreibung ist Freeware, du darfst sie kostenlos nutzen –
Aber sie ist nicht Open Source, d. h. du darfst sie nicht verändern oder in veränderter Form veröffentlichen.
Beitrag
von Alexander D. (Expert / 682 / 30 /
84
)
»
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.
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.
schöne Grüße
Alexander
ECC 6.0 EHP 7
Alexander
ECC 6.0 EHP 7
Moin zusammen,
ich stehe grad vor einem aehnlichen Problem: Ich moechte alle Programme, Modifikationen, UserExits, Feldabhaengigkeiten usw. dokumentieren, so dass jeder fuer die Programmierung oder das Customizen nach kurzer Suche alles Wissenswerte heraussuchen kann. Hier und da werden z.B. Felder ja auch "missbraucht", sowas weiss spaetestens nach 2 Jahren keiner mehr...
Hat jemand Erfahrungen mit solch Systemen gemacht? Die Idee von Thomas mit den Links im Quellcode finde ich schon relativ gut aber vielleicht gibt es da noch Alternativen.
Danke und Gruss
Lambert
ich stehe grad vor einem aehnlichen Problem: Ich moechte alle Programme, Modifikationen, UserExits, Feldabhaengigkeiten usw. dokumentieren, so dass jeder fuer die Programmierung oder das Customizen nach kurzer Suche alles Wissenswerte heraussuchen kann. Hier und da werden z.B. Felder ja auch "missbraucht", sowas weiss spaetestens nach 2 Jahren keiner mehr...
Hat jemand Erfahrungen mit solch Systemen gemacht? Die Idee von Thomas mit den Links im Quellcode finde ich schon relativ gut aber vielleicht gibt es da noch Alternativen.
Danke und Gruss
Lambert
Seite 1 von 1
Vergleichbare Themen
3
Antw.
Antw.
1242
Views
Views
3
Antw.
Antw.
2151
Views
Views
4
Antw.
Antw.
2431
Views
Views
Link ins Intranet innerhalb der Programmdoku
von Thomas R. » 01.06.2005 16:20 • Verfasst in SAP - Allgemeines
von Thomas R. » 01.06.2005 16:20 • Verfasst in SAP - Allgemeines
1
Antw.
Antw.
1197
Views
Views
Frage die ABAP Experten
Über diesen Beitrag
Unterstütze die Community und teile den Beitrag für mehr Leser und Austausch
Aktuelle Forenbeiträge
Umherspringende Methoden im quelltextbasierten Class Builder
vor 2 Stunden von ralf.wenzel 104 / 9995
vor 2 Stunden von ralf.wenzel 104 / 9995
Newsletter Anmeldung
Keine Beiträge verpassen! Wöchentlich versenden wir lesenwerte Beiträge aus unserer Community.Die letzte Ausgabe findest du hier.
Aktuelle Forenbeiträge
Umherspringende Methoden im quelltextbasierten Class Builder
vor 2 Stunden von ralf.wenzel 104 / 9995
vor 2 Stunden von ralf.wenzel 104 / 9995