Archiv

Artikel Tagged ‘Sandcastle’

Dokumentation für .NET-Klassen

4. August 2007 2 Kommentare

Das Erstellen einer Dokumentation und die ständige Aktualisierung speziell für .NET-Klassenbibliotheken sind sehr mühsam. Gleichzeitig sollen natürlich andere Programmierer die diese Klassenbibliothek verwenden im Klaren sein, welche Methoden, Eigenschaften,… die beinhalteten Klassen besitzen und was sie machen. Daher kann man bereits im Code über die XML-Kommentare kurze Erklärungen anbieten. Über den Objekt-Explorer bzw. IntelliSense von Visual Studio lassen sich diese dann auch abrufen, wenn nur eine kompilierte Version vorliegt.

Doch es geht auch besser. Die beim Kompilieren von Visual Studio exportierten XML-Dokumentationsdatei (Muss in den Projekteigenschaften im Register Erzeugen aktiviert sein.) enthält eigentlich bereits alles um daraus eine vollwärtige Dokumentation – die der MSDN Library ähnlich ist – zu erzeugen.
Mehr…