VBdocman ist ein Programm zur automatischen Generierung von technischer Dokumentation aus Ihren Visual Basic-Quelldateien mit nur wenigen Mausklicks. Es analysiert Quellcode und erstellt automatisch Inhaltsverzeichnis, Index, Themen, Querverweise und kontextsensitive Hilfe. Das Format der Ausgabedokumentation ist vom Benutzer vollständig konfigurierbar. Die vordefinierten Ausgabeformate sind:
HTML-Hilfe (*.chm-Datei, die wie MSDN aussieht)-
HTML-Dateien (mit Java-Index und Inhaltsverzeichnis)
WinHelp (*.hlp-Datei)
RTF-Dokument
Xml
VBdocman funktioniert als Add-In in MS Visual Basic 6.0. Nach Aufrufen eines einfachen Dialogs über das Hauptmenü und (im einfachsten Fall) durch Klicken auf eine Schaltfläche wird die angegebene Ausgabedokumentation generiert. Es erstellt automatisch alle interessanten Links wie Gilt für, Methoden, Ereignisse, Eigenschaften, Ereignisse, Inhaltsverzeichnis und Index. Bei größeren Projekten spart nur diese Arbeit viele Tage langweiliger Arbeit. Die Dokumentation kann dann bearbeitet und zusätzliche Beschreibungen wie siehe auch, Beispiele Links, Objekt, Methode, Eigenschaft oder Ereignisbeschreibung, Parameterbeschreibung und so weiter gegeben werden. VBdocman ermöglicht es, auch diese Beschreibung automatisch hinzuzufügen, indem es aus dem Quellcodekommentar aus speziellen Tags extrahiert wird. Es funktioniert ähnlich wie JavaDoc-System. Aber, Benutzer ist nicht gezwungen, Kommentare manuell zu schreiben, VBdocman fügt es selbst nur durch zwei Mausklicks. Alle notwendigen Tags werden hinzugefügt und der Benutzer füllt dann nur eine kurze Beschreibung aus. Darüber hinaus bietet es einen ausgeklügelten benutzerfreundlichen Kommentareditor.
Vorteile:
Konsistenz. Wenn etwas zu Code hinzugefügt wurde, z.B. neue Methode, wird es automatisch in neu generierter Dokumentation widergespiegelt.
Dokumentation in verschiedenen Formaten kann mit wenigen Mausklicks erstellt werden. So haben Sie Dokumentation in allen unterstützten Formaten in wenigen Minuten.
Effiziente Kommunikation innerhalb des Teams, insbesondere wenn Source Safe verwendet wird. Jeder Programmierer kommentiert seinen Teil des Codes.
VERSIONSVERLAUF
- Version 2.25 veröffentlicht auf 2005-11-09
Verbesserte Ausgabe und Fehlerbehebungen.
Programmdetails
Eula
EULA - Endbenutzer-Lizenzvertrag
VBDOCMAN LIZENZVERTRAG
Das VBdocman Add-In ist KEINE Freeware. Das bedeutet:
Alle Urheberrechte an VBdocman sind ausschließlich Eigentum des Autors - Peter Macej (HELIXOFT).
Jeder kann diese Software während eines Testzeitraums von 14 Tagen verwenden.
Nach dieser Testphase von 14 Tagen oder weniger, wenn Sie
um VBdocman zu verwenden, MÜSSEN Sie sich registrieren (kaufen). Wenn Sie VBdocman kaufen, werden Sie
registrierten Benutzer.
Es gibt folgende Arten von Lizenzen, die für VBdocman ausgestellt wurden:
1. Eine einzelne Computer USAGE Lizenz. Der Benutzer erwirbt EINE Lizenz
, um den VBdocman auf einem Computer zu VERWENDEN.
2. Eine SITE USAGE Lizenz. Der Benutzer erwirbt eine einzelne USAGE-Lizenz,
Genehmigung der USE von VBdocman durch den Käufer, die Käufer
Mitarbeiter oder akkreditierte Agenten auf einer unbegrenzten Anzahl von Computern
am gleichen physischen SITE-Standort. Dieser SITE-Standort würde
normalerweise als ein einzelnes Gebäude definiert werden, sondern als
eine Reihe von Gebäuden innerhalb derselben, allgemeiner, geografischer
wie ein Gewerbegebiet oder eine Kleinstadt.
Nach der Registrierung erhält der Nutzer eine nicht-exklusive Lizenz zur
VBdocman auf so vielen Computern, wie in den oben genannten Lizenzbedingungen definiert
nach der Anzahl der erworbenen Lizenzen, für jeden rechtlichen Zweck.
Sie dürfen nicht verwenden, kopieren, emulieren, klonen, vermieten, vermieten, verkaufen, modifizieren,
dekompilieren, disassemblieren, anderweitig zurückentwickeln oder übertragen
lizenziertes Programm oder eine Teilmenge des lizenzierten Programms,
in dieser Vereinbarung vorgesehen sind. Jede solche unbefugte Verwendung
sofortige und automatische Kündigung dieser Lizenz und kann
strafrechtliche und/oder zivilrechtliche Verfolgung.
Die VBdocman-Testversion kann frei verteilt werden,
sofern das Distributionspaket nicht geändert wird. Keine Person oder
kann eine Gebühr für den Vertrieb von VBdocman ohne schriftliche
Erlaubnis des Autors.
Anmeldung unter VBdocman Home Site http://www.vbdocman.com
BEGRENZTE GARANTIE
Der Autor garantiert nicht, dass die in dieser Software enthaltenen Funktionen
Ihren Anforderungen entsprechen oder dass die Software fehlerfrei ist.
IN KEINEM FALL HAFTET DER AUTOR IHNEN GEGENÜBER FÜR SCHÄDEN, EINSCHLIEßLICH
ENTGANGENE GEWINNE, ENTGANGENE ERSPARNISSE ODER SONSTIGE NEBEN- ODER FOLGESCHÄDEN
AUS DER NUTZUNG ODER UNFÄHIGKEIT, DIESES PROGRAMM ZU NUTZEN, ODER FÜR
VON JEDER ANDEREN PARTEI. DAS GESAMTE RISIKO HINSICHTLICH DER ERGEBNISSE UND DER LEISTUNG
DAS PROGRAMM UND DIE DOKUMENTATION WERDEN VON IHNEN ÜBERNOMMEN.
Der Autor behält sich das Eigentum an der Software vor. Alle Kopien und
Teile der Software, in welcher Form auch immer, gehören dem Autor, der
alle nicht ausdrücklich gewährten Rechte.
Die Installation und Verwendung von VBdocman bedeutet die Annahme dieser
Bedingungen der Lizenz.
Wenn Sie mit den Bedingungen dieser Lizenz nicht einverstanden sind, müssen Sie VBdocman
Dateien von Ihren Speichergeräten und hören Sie auf, das Produkt zu verwenden.
