Microsoft stellt leider kein Werkzeug zur Generierung einer Komponenten Hilfe aus dem dokumentierten Code mehr zur Verfügung. Wenigstens wird im neuen Visual Basic 2005 nun auch die Erstellung einer der Kommentars XML Datei unterstützt, analog zu der C# Sprache. Es gibt diverse Tools, die eine entsprechende Hilfe aus den XML Dateien erstellen können. Die Preisklasse variert dabei von nichts bis zu fast schon überrissenen Preisen.
NDoc
Visual Studio 2002 und 2003 Benutzer, welche auf NDoc (OpenSource) gesetzt haben, haben unter Visual Studio 2005 noch kein Nachfolger desselben Produktes. Die Entwicklung ist zwar am Laufen, doch eine Ende ist noch nicht wirklich absehbar. Auf der Jonas Blog Seite wird allerdings eine Erweiterung des bestehenden NDoc Tools angeboten, allerdings entsprechen die generierten Seiten nicht wirklich dem MSDN .NET Framwork 2.0 Standard. Einige XML Tags werden zudem nicht oder nur sehr unschön unterstützt.
X.Doc
Ein weiteres Tool ist X.Doc (OpenSource), unterstützt aber kein Visual Basic .NET. Es bietet zudem ein direktes AddIn im Visual Studio 2005. Dieses Tool habe ich noch nicht weiter getestet.
ComponentOne Doc2Help 2006
Dieses kostenpflichtige Tool von ComponentOne unterstützt die Erstellung von allerlei Hilfen und Handbüchern. Auch ein Dokumentationstool für Komponenten ist inbegriffen, doch die generierten Hilfen sind recht schlecht und teilweise werden gar verschiedene Klassen, Methoden bzw. Eigenschaften einfach ignoriert. Das ganze Tool basiert zudem auf Microsoft Word Dokumenten und hat immer wieder Mühe mit dieser API. Auch werden die Kommentare aus dem Code zuerst in ein Worddokument geschrieben und erst danach als Hilfe kompiliert.
Innovasys Document! X
Dieses doch recht kostspielige Tool von Innovasys generiert eine absolut perfekte Hilfe im MSDN .NET Framework 2.0 Stil. Zudem erlaubt dieses Tool die Hilfe beliebig zu erweitern. Dazu gehört auch, dass diverse zusätzliche Seiten pro Namespace erstellt und diese auch direkt im Tool dokumentiert werden können. Das Tool unterstützt nicht nur die Generierung von Hilfen aus .NET XML Dateien, sondern auch aus Visual Basic 2002/2003 und VB 6 Projekten. Auch ganz schön ist die Dokumentationserstellung aus einer Datenbank.
Alle Übersichten werden zudem, ähnlich wie in der MSDN Hilfe auch noch grafisch aufgepuscht (siehe auch angehängte Screenshots).
Dieses Tool ist absolut empfehlenswert und kann zudem noch mit dem Produkt Innovasys HelpStudio verknüpft werden. Eine Light Version dieses Produktes ist über das Microsoft Visual Studio 2005 SDK verfügbar. Mit diesem Produkt können beliebige Help 2.0 Hilfen erstellt werden, zudem kann ein Document! X Projekt als Knoten integriert werden.
Um das Studio 2005 SDK herunterladen zu können muss man sich allerdings zuerst registrieren. Das Studio SDK bietet zudem die API zur Kompilation von Hilfen der Version 2.0.
www.codeproject.com/useritems/xdoc.asp
www.componentone.com/products.aspx
msdn.microsoft.com/vstudio/extend/default.aspx
