Hallo,
gibt es eigentlich ein brauchbares Tool um automatische eine Softwaredokumentation zu erstellen?
Z.B. sowas wie doxygen, wo man spezielle Kommentare/Tags anbringen muss und am Ende eine Dokumentation raus kommt:
- welche Klassen gibt es
- welche Methoden/Attribute in einer Klasse
- Übersicht über Klassenvererbung
- welche Funktionen gibt es
- was (Klassen/Funktionen) ist in welcher datei
Es ist sicher aufwendig, alle Features (dank Makros bzw. allgemein dem dynmaischen Charakter von Xbase) abzubilden,
aber vielleicht gibt es ja doch was?
In der Newsgroup gibts von Philip Jackson "CodeMapper", was aber bei mir nicht läuft (fehlende XPPSYS.dll??)
aber das soll auch primär nur mit Funktionen gute Dienste leisten.
Ich hab ja gehofft, als ich von der eingebauten Dokumentation in Visual Xbase:
/// <summary>
/// <para>
/// </para>
///</summary>
gelesen hab, dass damit rudimentäre Ansätze zum Generieren bereits möglich sind, aber das ist wohl (noch) nicht der Fall...
Softwaredokumentation wie doxygen
Moderator: Moderatoren
- Jan
- Marvin
- Beiträge: 14653
- Registriert: Fr, 23. Sep 2005 18:23
- Wohnort: 49328 Melle
- Hat sich bedankt: 21 Mal
- Danksagung erhalten: 88 Mal
- Kontaktdaten:
Re: Softwaredokumentation wie doxygen
Hallo Robert,
die eingebaute Doku in VX funktioniert. Ich benutze die ausgiebig. Ist halt nur ein dickes Stück Arbeit, das erstmal einzubauen. Automatisch geht da garnichts.
Jan
die eingebaute Doku in VX funktioniert. Ich benutze die ausgiebig. Ist halt nur ein dickes Stück Arbeit, das erstmal einzubauen. Automatisch geht da garnichts.
Jan
Mitglied der XUG Osnabrück
Mitglied der XUG Berlin/Brandenburg
Mitglied des Deutschsprachige Xbase-Entwickler e. V.
Mitglied der XUG Berlin/Brandenburg
Mitglied des Deutschsprachige Xbase-Entwickler e. V.
- Manfred
- Foren-Administrator
- Beiträge: 21189
- Registriert: Di, 29. Nov 2005 16:58
- Wohnort: Kreis Wesel
- Hat sich bedankt: 210 Mal
- Danksagung erhalten: 67 Mal
Re: Softwaredokumentation wie doxygen
Hi,
das dienst nur dem Zweck wenn eigene Funktionen aufgerufen werden, dass eine Erklärung erscheint. Das klappt aber nicht richtig. Sobald bestimmte Schlüsselworte vorher im Quelltext stehen, wird nur noch die Parameterliste angezeigt. Ist aber glaube ich auch erst seit 2006 oder so bekannt.
das dienst nur dem Zweck wenn eigene Funktionen aufgerufen werden, dass eine Erklärung erscheint. Das klappt aber nicht richtig. Sobald bestimmte Schlüsselworte vorher im Quelltext stehen, wird nur noch die Parameterliste angezeigt. Ist aber glaube ich auch erst seit 2006 oder so bekannt.
Gruß Manfred
Mitglied der XUG Osnabrück
Schatzmeister des Deutschsprachige Xbase-Entwickler e.V.
großer Fan des Xbaseentwicklerwiki https://wiki.xbaseentwickler.de/index.p ... Hauptseite
Doof kann man sein, man muß sich nur zu helfen wissen!!
Mitglied der XUG Osnabrück
Schatzmeister des Deutschsprachige Xbase-Entwickler e.V.
großer Fan des Xbaseentwicklerwiki https://wiki.xbaseentwickler.de/index.p ... Hauptseite
Doof kann man sein, man muß sich nur zu helfen wissen!!
- AUGE_OHR
- Marvin
- Beiträge: 12906
- Registriert: Do, 16. Mär 2006 7:55
- Wohnort: Hamburg
- Hat sich bedankt: 19 Mal
- Danksagung erhalten: 45 Mal
Re: Softwaredokumentation wie doxygen
Danke für den Tip aber ohne Link ...Robert hat geschrieben:In der Newsgroup gibts von Philip Jackson "CodeMapper", was aber bei mir nicht läuft (fehlende XPPSYS.dll??)
die XppSys.DLL gibt es erst seit der v1.9x ... hast du noch die v1.8x ?
gruss by OHR
Jimmy
Jimmy
Re: Softwaredokumentation wie doxygen
Ich hab die v1.9x aber weder im lib noch im runtime Verzeichnis gibts die XPPSys.dllAUGE_OHR hat geschrieben:Danke für den Tip aber ohne Link ...Robert hat geschrieben:In der Newsgroup gibts von Philip Jackson "CodeMapper", was aber bei mir nicht läuft (fehlende XPPSYS.dll??)
die XppSys.DLL gibt es erst seit der v1.9x ... hast du noch die v1.8x ?
Dokumentation:
Newsgroup: 3pp
Betreff: CodeMapper for xBase Languages - looking for early adopters
Datum 29.09.2011
Newsgroup: Xbabse.generic
Programm:
Betreff: How to generate automatically a Flow Chart from source Code
Datum: 13.09.2011 23:33 (Dort sind die zip-Dateien)
- AUGE_OHR
- Marvin
- Beiträge: 12906
- Registriert: Do, 16. Mär 2006 7:55
- Wohnort: Hamburg
- Hat sich bedankt: 19 Mal
- Danksagung erhalten: 45 Mal
Re: Softwaredokumentation wie doxygen
sorry ich meine die v1.9.355 SL1Robert hat geschrieben:Ich hab die v1.9x aber weder im lib noch im runtime Verzeichnis gibts die XPPSys.dll
wenn du nur die v1.9.331 hast dann gibt es die XppSys.DLL nicht !
bei der v1.9.355 SL1 siehe mal in das Verzeichniss x:\ALASKA\XPPW32\Source\dll\.
Dort müsste ein README.TXT und eine PROJECT.XPJ sein.
ok danke.Robert hat geschrieben:Dokumentation:
Newsgroup: 3pp
Betreff: CodeMapper for xBase Languages - looking for early adopters
Datum 29.09.2011
Newsgroup: Xbabse.generic
Programm:
Betreff: How to generate automatically a Flow Chart from source Code
Datum: 13.09.2011 23:33 (Dort sind die zip-Dateien)
ich habe ja in den (englischen) Threads schon geantwortet.
ähnlich wie das "CodeMapper" EXE verwende ich "alten" Cl*pper Code der "aufgebohrt" wurde für Xbase++.
man kann damit nun auch "dokumentieren" ... aber eben nur so viel wie man "ihm" beigebracht hat.
ich gehe mal davon aus das wir über "Source Code Dokumentation" sprechen der es z.b. einem Nachfolger ermöglicht sich in den Source einzuarbeiten.
als Programmierer interessieren mich zunächst die Procedure / Function, was die machen, und deren Parameter.
Tools wie CodeMapper, CLICK!, SNAP, DFlow usw. können da nur begrenzt "mitdenken" was der Programmierer sich mit den Parametern (a,b,c) gedacht hat.
diese Information gehört in den Header wo auch ein Nachfolger die sofort findet.
einige Editoren können Kommentare "direkt" im Source einfügen und die später für Dokumentation verwenden.
gruss by OHR
Jimmy
Jimmy