Doctor Source 2.3

von Mario Zeller

Übersicht

Anfang 2001 habe ich die Version 1.4 des Dokumentationstools Doctor Source in einem Tutorial vorgestellt. Mittlerweile liegt Version 2.3 vor, in dieser Kolumne soll sie nun unter die Lupe genommen werden.

Doctor Source steht für Doc umentation To ol fo r VB- Source code und ist ein Programm, das Komponenten- und Team-Entwickler bei der Erstellung von Dokumentationen zu ihren VB-Projekten unter den Arm greift.

Ein Dankeschön geht an den Entwickler des Tools Daniel Springwald, der für dieses Review eine kostenlose Vollversion zur Verfügung gestellt hat.

Erste Schritte

Eine 60-Tage-Testversion steht auf der Homepage www.doctorsource.de kostenfrei zur Verfügung.

Download von www.doctorsource.de (6 MB)

Nach dem Start sticht sofort die neue Programmoberfläche ins Auge, die zwar etwas gewöhnungsbedürftig ist, jedoch mehr Features als die Oberfläche aus Version 1.4 bietet. So ist es nun möglich, Dokumentationen zu mehreren Projekten auf einmal erstellen zu lassen (Batchfunktion)

Abbildung 1: Die neue Programmoberfläche

Die Dokumentation

Mit einem Klick auf Bearbeiten und neue Aufgabe hinzufügen kann man jetzt VB-Projektdateien zur Verarbeitung laden.

In den einzelnen Spalten lassen sich nun einige Einstellungen wie z.B. der Ausgabepfad anpassen. Weiterhin kann man sich die Projekt-Struktur in einem Treeview visualisieren lassen.

Mit einem Klick auf Start wird mit der Erzeugung der Dokumentation begonnen.

Im Zielverzeichnis finden sich jetzt einige HTML- und Bilddateien sowie zwei Microsoft HTML Help-Workshop-Dateien. Der HTML-Workshop ist kostenfrei unter Microsoft HTML Help 1.4 SDK zu bekommen. Mit dem HTML Help-Workshop lassen sich die Dateien anschließend zu einer HTML-Hilfedatei kompilieren bzw. entsprechend modifizieren.

Abbildung 2: Eine fertige Hilfe-Datei

Kommentare im Source-Code

Eine so erzeugte Hilfe-Datei ist schon recht brauchbar. Sie beinhaltet bereits alle wichtigen Projektdaten. Bei Methoden werden z.B. die Parameter mit Datentypen und eventuellen Verweisen auf UDTs sowie der Rückgabedatentyp angegeben.

Will man Zusatzinformationen wie Beschreibungen der einzelnen Methoden und Variablen in der Hilfe unterbringen, so müssen spezielle Kommentare in den Quellcode eingefügt werden. Dies geschieht wie in Version 1.4. Eine Liste mit Erklärung der einzelnen Kommentare ist in der Doctor Source-Hilfe zu finden.

Ein Beispielcode:

Public Sub Test(ByVal EinWert As Integer, _
                 ByVal NocheinWert As String)
        'desc: Diese Subroutine hat noch keine erkennbare Funktion
        'para(EinWert): Ein Parameter vom Typ Integer, der wasweißich beinhaltet
        'para(NocheinWert): Mit diesem Parameter wird der Name von wasauchimmer übergeben
End Sub

Templates

Durch den Erwerb der Vollversion von Doctor Source hat man die Möglichkeit, die Templates für die Hilfe-Dateien nach dem eigenen Geschmack anzupassen.

Abbildung 3: Ein individuelles Template

Fazit

Doctor Source bietet das, was in .NET schon lange möglich ist, auch für VB6: Eine große Hilfe bei der Erstellung von Dokumentationen eigener Projekte. Mit wenigen Mausklicks ist es möglich, eine Dokumentation komplett zu aktualisieren, was eine große Entlastung für Entwickler von Komponenten bedeutet. Ein weiteres interessantes Feature ist die Möglichkeit zur Erstellung eigener Templates. Bis auf die neue Oberfläche und eine deutliche Geschwindigkeitssteigerung bei der Erstellung von Dokumentationen gibt es außer einigen Kleinigkeiten jedoch kaum Unterschiede zur Version 1.4. Mal schauen, was in Zukunft noch an neuen Features hinzukommt.

Die Vollversion schlägt mit 129 Euro zu Buche, was meiner Meinung nach ein bisschen teuer ist. Jedoch bietet der Entwickler durch eine 60-Tage-Evaluationsversion Interessenten die Möglichkeit, sich vor dem Kauf ausgiebig von der Leistungsfähigkeit des Tools zu überzeugen. Für Programmierer, die ihre Komponenten kommerziell vertreiben, sollte sich das Programm aber auf jeden Fall lohnen.

Weitere Informationen, ein Bestellformular und die Demo-Version gibt es auf der Doctor Source-Homepage: www.doctorsource.de.

Ihre Meinung

Falls Sie Fragen zu diesem Artikel 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.