www.mikrocontroller.net

Forum: PC-Programmierung Windows Programme Dokumentieren


Autor: Daniel Duesentrieb (daniel1976d)
Datum:

Bewertung
0 lesenswert
nicht 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

Autor: Jaecko (Gast)
Datum:

Bewertung
0 lesenswert
nicht 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.

Autor: stinkywinky (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Es gibt einen Filter für Doxygen: pas2dox

Autor: Stefan B. (stefan) Benutzerseite
Datum:

Bewertung
0 lesenswert
nicht 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.

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.