Sie sind hier
Sandcastle
Eintrag zuletzt aktualisiert am: 28.04.2015
Sandcastle ist der Namen eines Microsoft-Werkzeuge für die Erstellung Code-Dokumentation für .NET-Assemblies (vergleichbar mit dem Open Souce-Werkzeug NDoc).
Geschichte
- Erstankündigung: 29.6.2006 http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=517576&SiteID=1
- Erstes CTP-Version: 29.7.2006 http://www.microsoft.com/downloads/details.aspx?FamilyID=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
- Sandcastle wurde bis 2010 von Microsoft weiterentwickelt
- 2012 wurde das Projekt von Eric Woodruff übernommen und weitergeführt bei Github: https://github.com/EWSoftware/SHFB
Hintergrund
Die Programmiersprachen C# (seit Version 1.0) und Visual Basic (seit Version 8.0) erlauben, den Programmcode mit speziellen Kommentaren in XML-Form anzureichern. Die Sprachcompiler erzeugen aus den XML-Kommentaren XML-Dokumente, die zudem mit den in den Assemblies hinterlegten Metadaten dazu dienen können, eine Dokumentation für die Assembly automatisch zu generieren.
In Visual Studio 2003 war eine Funktion enthalten, die (nicht besonders ansehnliche) HTML-Dokumente auf Basis der Assembly-Metadaten und XML-Kommentare erzeugte. In Visual Studio 2005 ist keine derartige Funktion enthalten. Microsoft hatte wohl eingesehen, dass das eingebaute Werkzeug viel schlechter war als NDoc (http://ndoc.sourceforge.net/), ein Open Source-Dokumentationswerkzeug, das neben HTML-Dateien auch viele andere Ausgabeformate unterstützt, u.a. kompilierte HTML-Dateien (.chm), die aussehen wie die MSDN-Dokumentation von Microsoft.
Seit 2006 ist Sandcastle das De-Facto-Standard-Werkzeug für die Hilfegenerierung aus .NET-Code.