Forum: PC-Programmierung Windows Programme Dokumentieren


von Daniel D. (daniel1976d)


Lesenswert?

Halloechen,

ich suche fuer die automatische Dokumentation von GUIs ein Program. Fuer 
unsere Programme (VBasic, Delphi) benutzen wir sehr viele Graphische 
Elemente und eine relativ komplizierte Menuefuerung. Falls moeglich 
suchen wir etwas das die Dokumentation vereinfacht, beschleunigt und 
standarisiert.

Zur Zeit haben wir einen technischen Writer der Snapshots des GUI macht 
und dann alle Menuepunkte durchgeht und diese in einer darunter 
befindlichen Tabelle erklaert.... Wenn dann ein Dokument so ca. 200 
Seiten hat schleichen sich etliche Fehler ein...

Hat da jemand vieleicht Erfahreungen und koennte uns den ein oder 
anderen Tip geben???

Danke

von Jaecko (Gast)


Lesenswert?

Wär das ganze jetzt in C würd ich mal Doxygen vorschlagen. Ob das mit VB 
und/oder Delphi zurecht kommt, weiss ich nicht.

von stinkywinky (Gast)


Lesenswert?

Es gibt einen Filter für Doxygen: pas2dox

von Stefan B. (stefan) Benutzerseite


Lesenswert?

Ich sehe keine Möglichkeit diesen Prozess zu ersetzen.

Man könnte den Prozess unterstützen, in dem konsistente Namen für die 
Elemente verwendet werden und ein Teil der Tabelle(n) automatisch 
erzeugt wird. Dazu könnte man die Symbolnamen aus dem Designprozess der 
GUI nutzen (automatisch extrahieren...).

Damit wäre z.B. sichergestellt, dass alle im Programm verwendeten 
Symbole auch als Snapshot eingebunden werden. Und die Arbeit des Writers 
könnte besser durch die Programmierer kontrolliert werden.

Wenn die Programmierer zusätzlich hingehen und zu den Symbolnamen 
Docstrings anlegen, könnten diese Hinweise auch in die Tabelle 
übernommen werden und den Writer bei der Ausformulierung der Anleitung 
unterstützen.

Umgekehrt könnte die Formulierung des Writers auch in Docstrings für den 
Programmierer umgewandelt werden, damit beschriebene Funktionen bei der 
Überarbeitung des Programmcodes konsistent bleiben.

Die Symbolnamen sind dann "Leim" zwischen dem Austausch.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.