1. Herfried K. Wagner’s VB.Any
  2. .NET
  3. Code

Verteilung und Dokumentation

XML-Kommentare und Klassendokumentation

C# bietet die Möglichkeit der Verwendung von XML-Kommentaren im Quellcode, aus denen anschließend eine Dokumentation erstellt werden kann. In Visual Basic .NET ist dies seitens Microsoft bis einschließlich Version 2003 nicht implementiert. Trotzdem können XML-Kommentare auch mit diesen Versionen verwendet werden, um daraus einerseits eine Dokumentation, andererseits aber auch Beschreibungen, die z. B. bei IntelliSense in der Entwicklungsumgebung von Visual Studio .NET angezeigt werden, erstellen zu können. Im Folgenden wird eine Übersicht über Werkzeuge für diesen Zweck geboten:

VB Commenter

Ein von Microsoft geschriebenes Werkzeug, das Teil der PowerToys für Microsoft Visual Studio .NET ist und die Verwendung von XML-Kommentaren in Visual Basic .NET erlaubt.

XML Documentation

Das Microsoft Visual Basic .NET-Team hat ein Werkzeug entwickelt, das eine nachträgliche Kommentierung des Quellcodes ermöglicht. Daraus wird eine XML-Datei erstellt, die in eine Dokumentation umgewandelt werden kann.

VB.DOC

Markus Palme entwickelt VB.DOC, ein Programm, das XML-Kommentare aus Visual Basic .NET-Quellcode herausfiltert und eine XML-Datei erstellt.

VBXCVB.NET XML Commentor

Ein Werkzeug zur Unterstützung von XML-Kommentaren in Form eines Add-Ins für Visual Studio .NET.

Die oben genannten Programme erzeugen XML-Dateien, die mit dem Werkzeug NDOC in HTML umgewandelt werden können:

NDOC (formerly DOC.NET)

NDOC erstellt HTML-Hilfedateien basierend auf XML-Dokumentationsdateien.

Eine Erweiterung von NDOC stellt folgendes Werkzeug von Markus Diettrich dar:

NDoc Plugin “MSDN DE

Erweiterung von NDOC zur Erzeugung deutschsprachiger Dokumentationen.