vb@rchiv
VB Classic
VB.NET
ADO.NET
VBA
C#
sevDataGrid - G?nnen Sie Ihrem SQL-Kommando diesen kr?nenden Abschlu?!  
 vb@rchiv Quick-Search: Suche startenErweiterte Suche starten   RSS-Feeds  | Newsletter  | Impressum  | Datenschutz  | vb@rchiv CD Vol.6  | Shop Copyright ©2000-2017
 
zurück
Doctor Source - Dokumentationstool für VB-Projekte

"Erzeugen Sie Dokumentationen zu Ihren VB-Projekten per Knopfdruck". So lautet der Werbeslogan auf der Internetseite von Daniel Springwald, Autor dieses Tools. Doctor Source erstellt jederzeit auf Knopfdruck eine HTML-Dokumentation / HTML-Help mit der vollständigen Struktur Ihres Projekts, einschließlich der gesamten Funktions- und Prozedur-Deklarationen. Wir haben "Doctor Source" unter die Lupe genommen und waren gespannt, ob das Tool die Ansprüche erfüllt und tatsächlich so einfach zu bedienenen ist.
15.09.03Ein Bericht von Gerhard Kuklau

Version 2.3
Autor: Daniel Springwald
 www.doctorsource.de

Vertrieb: über das Internet (www.doctorsource.de)

Die Software kann unter vorgenannter Adresse heruntergeladen und 60 Tage lang kostenlos getestet werden.

Installation
Zur Installation müssen Sie das ZIP-Archiv entpacken und anschließend Setup.exe aufrufen. Der Zielpfad (Installationspfad) kann gewählt werden. Bei der Installation trat folgende Fehlermeldung auf, die aber scheinbar keinen Einfluss auf die spätere Lauffähigkeit von Doctor Source hat:

Dokumentation
Die Dokumentation beschränkt sich auf eine HTML-Hilfe-Datei, die nur die nötigsten Informationen enthält. Mir persönlich liegt das sehr, denn ich finde es sehr lästig, mich erst durch dicke Bücher / Dokumente schlagen zu müssen, um eine Software bedienen zu können. Was den Umfang der Dokumentation anbelangt, hat Daniel Springwald meinen Geschmack getroffen, leider nicht mit den Informationen, die in der HTML-Help-Datei enthalten sind.

Erster Kontakt mit Doctor Source
Ich habe ein zur Zeit in Bearbeitung befindliches Projekt genommen, um eine Beispiel-Doku zu erstellen. Die von mir im Projekt spärlich verwendeten Doctor-Source-Tags haben dem Ergebnis mehr "Inhalt" gegeben.

In der Tat ist es sehr einfach mit den 11 zur Verfügung stehenden Tags die Vorbereitung für die automatische Dokumentation zu bewerkstelligen. Hier würde ich mir allerdings wünschen, wenn es in einer folgenden Version möglich wäre, selbst Tags anzulegen, z.B. ein Picture-Tag, um Grafiken / Hardcopies in der Doku aufnehmen zu können (Hardcopy der verwendeten Forms).

Die Oberfläche ist etwas gewöhnungsbedürftig. Es ist schade, dass die Möglichkeiten des Tooltipps nicht genutzt werden, um die einzelnen Spalten und deren Funktionen im Grid (Aufgabenspalten) zu erläutern. Dies wird zwar durch eine Legende unterhalb des Aufgaben-Grids erledigt, aber der Umgang damit ist doch sehr gewöhnungsbedürftig.

Dokumentationstypen
Doctor Source bietet zwei Dokumentationstypen bzw. Formate an:

  • HTML-Report
  • HTML-Hilfe-Datei
Standardmäßig erstellt Doctor Source ein Verzeichnis (natürlich frei wählbar), in dem alle nötigen HTML-Dateien und Bilder (für das Layout) abgelegt werden. Dieses Verzeichnis kann nach der Erstellung in jede beliebige Struktur kopiert werden, so dass der Anwender hier eine eigene Dokumentationsstruktur für alle seine Projekte anlegen kann. Die Start-Datei heißt Index.htm, so dass es nicht schwer sein wird, die Projekte in einer eigenen Struktur einzuordnen.

Die Erstellung der HTML-Hilfe-Datei, die mich persönlich am meisten interessierte, gestaltet sich da schon etwas schwieriger. Nach der ersten Erstellung habe ich vergeblich die HTML-Hilfe (*.chm) gesucht. Die Hilfe-Datei von Doctor Source hat hier leider auch keinerlei Auskunft gegeben. Lediglich in den Aufgabenspalten des Grids gibt es die Auswahlmöglichkeit HTML-Dateien schreiben zu lassen.

Daraufhin habe ich den Support ausprobiert und Daniel Springwald eine Mail geschickt.

Wenn auch die Hilfe darauf keine Antwort gab, so funktioniert doch der Support vorbildlich. Innerhalb von einer (!) Stunde hatte ich die Antwort: Bei Microsoft muss zur Erstellung der HTML-Dateien der HTML-Workshop heruntergeladen werden ( www.microsoft.com/office/ork/xp/appndx/appa06.htm). Doctor Source erstellt das für den HTML-Workshop erforderliche HTML-Projekt.

Das Projekt ließ sich kompilieren und es wurde erwartungsgemäß die HTML-Hilfe-Datei erstellt.

Was mir nicht gefiel
Der Menü-Punkt Service beinhaltet folgende Auswahlmöglichkeiten:

  • Doctor Source Homepage
  • Newsletter abonnieren
  • User-Group besuchen
  • Service-Informationen importieren
  • Wartung
Abgesehen von der unglücklichen Bezeichnung (Service-Informationen importieren steht für Lizenzinformationen eintragen / importieren) funktionieren Newsletter abonnieren und User-Group besuchen nicht, denn die Funktionen stehen zur Zeit leider nicht zur Verfügung.

Wie weiter oben schon beschrieben, ist die Oberfläche leider nicht so intuitiv zu bedienen, wie ich es mir von Anwendungen wünsche. Dazu gehört die gewöhnungsbedürftige Bedienung der Legende und die fehlenden Tooltipps für das Aufgaben-Grid.

Der fehlende Hinweis darauf, wie das HTML-Help-File erstellt wird.

Was mich am meisten gestört hat, ist die Tatsache, dass Doctor Source pro Sub/Function... nur einen Dokumentationsblock (z.B. DESC auswertet und in die Doku übernimmt. Sobald eine Leerzeile und Code-Zeile dazwischen auftaucht, werden die übrigen (von mir gezielt erstellen Dokumentationszeilen) nicht in die Doku übernommen! Das sollte unbedingt geändert werden, denn genau hier liegt ein ungeheuer großer Vorteil, wenn der Programmierer wirklich im Code die Doku an der richtigen Stelle unterbringen kann und sich sicher ist, dass sie anschließend auch im Dokument erscheint. Dazu wäre es auch hilfreich, wenn der Tag DESC für die globale Beschreibung der Funktion und der REM-Tag im Code zur Verwendung kommen würde.

Bei der Erstellung der Doku sollte die Auswertung der REM-Tags angeboten werden. Dadurch hat der Programmierer die Möglichkeit eine Doku mit und / oder ohne aller Inline-Dokumentationen zu erstellen.

Registrierung
Doctor Source kann als Testversion kostenfrei heruntergeladen und getestet werden. Die Vollversion lässt sich online über Share-It bestellen und kostet 129,00 EUR. Mit dem Kauf erhält man per E-Mail die notwendigen Unterlagen zum Download und Freischaltung der Vollversion. Die Freischaltung selbst erfolgt im Programm über das Menü "Service - Service-Informationen importieren".

Bewertung

Doctor Source
GESAMTWERTUNG
PREIS / LEISTUNGmangelhaft
Preis:129,- EUR
Weitere Infos unter:http://www.doctorsource.de
  guter und schneller Support
  gewöhnungsbedürftige Oberfläche
  Auswertung nur eines Doku-Blockes
  hoher Preis

Fazit
Die Aussage "Erzeugen Sie Dokumentationen zu Ihren VB-Projekten per Knopfdruck" ist etwas überzogen. Doctor Source von Daniel Springwald ist ein Tool, das von der Idee her gut und auf dem richtigen Weg ist. Leider ist es noch nicht so weit gereift, dass es wirklich empfohlen werden kann. Durch den sehr hohen Preis wird der Eindruck leider negativ verstärkt.

Kontakt
Software-Entwicklung, Daniel Springwald
Kurfürstenstrasse 12
44623 Herne
Fax: 089 / 2443 - 72313
 Daniel Springwald

 Download (6,4 MB)   |   weiter Homepage Bestellen

Diese Seite wurde bereits 16.681 mal aufgerufen.

nach obenzurück
 
   

Druckansicht Druckansicht Copyright ©2000-2017 vb@rchiv Dieter Otter
Alle Rechte vorbehalten.
Microsoft, Windows und Visual Basic sind entweder eingetragene Marken oder Marken der Microsoft Corporation in den USA und/oder anderen Ländern. Weitere auf dieser Homepage aufgeführten Produkt- und Firmennamen können geschützte Marken ihrer jeweiligen Inhaber sein.

Diese Seiten wurden optimiert für eine Bildschirmauflösung von mind. 1280x1024 Pixel