Die Community zu .NET und Classic VB.
Menü

Programmbesprechung Doctor Source

 von 

Übersicht 

Es gibt viele Personen, die ein Programm gemeinsam mit anderen schreiben oder für andere schreiben. Mit wachsender Größe des Projekts wird es aber immer schwieriger, die Übersicht darüber zu behalten. Also muss eine Dokumentation her. So etwas zu schreiben, ist aber sehr mühsam und zeitaufwendig. Deshalb haben findige Programmierer Tools entwickelt, die einem beim Schreiben von Dokumentationen unter die Arme greifen. Eines davon ist das Documentation Tool for VB-Sourcecode kurz Doctor Source von Daniel Springwald. Man kann es auf der Homepage http://www.doctorsource.de/de/inhalt/download.htm kostenfrei herunterladen. In dieser Besprechung soll es nun kurz vorgestellt werden.

Mit freundlichen Grüßen,
Mario Zeller

Inhalt

Programm-Besprechung: "Doctor Source"  



Abbildung 1: Projektstruktur

Nachdem man das Programm installiert, gestartet und den Info-Bildschirm weggeklickt hat, kann es losgehen. Über Projekt, Projekt öffnen kann man ein Visual Basic 6 Projekt landen und analysieren lassen. Wichtig ist dabei allerdings, dass sich das Projekt fehlerfrei mit VB kompilieren lässt. Die Analyse kann nun je nach Umfang des Codes einige Minuten in Anspruch nehmen.

Nun kann man mit Klick auf Dokumentation erstellen eine solche im HTML-Format erzeugen lassen. Es werden dann alle Formulare, Module, Klassenmodule, Funktionen, Sub-Routinen, Konstanten, Variablen und so weiter dokumentiert. In dem vorher angegebenen Verzeichnis finden sich nun einige Bild- und HTML-Dateien sowie jeweils eine .hhp- und eine .hhc-Datei. Letztere können von dem Microsoft HTMLHelp-Utility geöffnet werden, das sich auf der Visual Studio 6 CD befindet und das man sich auch von der Microsoft-Homepage downloaden kann. Damit ist es sogar möglich Microsoft HTML-Help Dateien zu erstellen, das Hilfe-Format das seit Windows 98 mit dabei ist. Dies sieht alles nun noch etwas roh aus, lässt sich aber durchaus schon verwenden.


Abbildung 2: HTML-Help

Um nun eigene Kommentare zu den jeweiligen Elementen hinzuzufügen, muss man nur seinen Source-Code etwas verändern. Ein kleines Beispiel:

Public Sub Test(ByVal EinWert As Integer, _
                 ByVal NocheinWert As String)
        'desc: diese Subroutine hat noch keine Funktion

        'para(EinWert): Dieser Parameter kann an die
        '               Subroutine als Integer übergeben
        '               werden

        'para(NocheinWert): Dieser Parameter kann an die
        '                   Subroutine als String übergeben
    '                   werden
End Sub


Man muss also einfach seine Kommentare mit entsprechenden Steuer-Befehlen für Doctor Source modifizieren, um eine genauere Auflistung in der Dokumentation erreichen. Von diesen Befehlen gibt es einige: author, change, copy, create, desc, email, hide, name, para, rem und return. Ihre genauen Funktionen kann man in der Doctor Source Hilfe nachlesen.

Der Vorteil dabei ist nun, dass man den Code noch immer beliebig verändern und einfach automatisch eine neue Dokumentation vom Programm erzeugen lassen kann. Damit gehören auch Probleme mit Dokumentationen, die nicht mit dem Source-Code übereinstimmen, der Vergangenheit an.

Die frei verfügbare Version von Doctor Source bietet fast keine Beschränkungen. In der Vollversion entfallen jedoch künstliche Wartezeiten und man kann seiner Hilfe auch ein individuelles Aussehen verpassen.

Fazit: Doctor Source erleichtert die unliebsame Arbeit Programm- oder OCX-Dokumentationen zu erstellen wesentlich, indem es fast alles automatisch erledigt, bietet dem Programmierer jedoch immer noch genügend Kontrolle durch seine Steuer-Kommentare. Empfehlenswert!

Ergänzung vom 28. August 2003: Dieses kurze Review wurde über Version 1.4 geschrieben. Doctor Source liegt mittlerweile in der Version 2.3 vor. Ein Review dieser Version ist in Kolumne 16 zu finden.

Ihre Meinung  

Falls Sie Fragen zu diesem Tutorial haben oder Ihre Erfahrung mit anderen Nutzern austauschen möchten, dann teilen Sie uns diese bitte in einem der unten vorhandenen Themen oder über einen neuen Beitrag mit. Hierzu können sie einfach einen Beitrag in einem zum Thema passenden Forum anlegen, welcher automatisch mit dieser Seite verknüpft wird.