.NET bietet mit den XML-Comments im Source-Code eine gute Möglichkeit, alle Klassen, Funktionen und Properties zu dokumentieren. Visual-Studio nutzt diese XML-Comments um diese im IntelliSense anzuzeigen.
Um aus diesen Kommentaren auch eine Dokumentation zu erstellen, sind weitere Schritte notwendig.
Wir benutzen dazu mit SHFB – SandCastle Help File Builder ein frei verfügbares Tool. Dieses integriert sich in Visual-Studio und stellt dort einen eigenen Projekttyp zur Verfügung.
Neben der generierten API-Dokumentation kann hier auch weiterer Inhalt (z.B. ein Klassendiagramm, Beschreibungen) hinzugefügt werden.
ACHTUNG: Bei der Installation von SHFB kommt es vor, dass trotz Erfolgsmeldung die Integration in Visual-Studio nicht korrekt installiert wird. Zur Korrektur ist lediglich aus dem Installationsverzeichnis die Datei InstallResourcesSHFBVisualStudioPackage.vsix durch Doppelklick beim aktuellen Benutzer korrekt zu registrieren.
Ist doch cool, oder?
