Sandcastle ist der Name eines Microsoft-Werkzeugs für die Erstellung von Code-Dokumentation für .NET-Assemblies (vergleichbar mit dem Open Source-Werkzeug NDoc).
Sandcastle wurde bis 2010 von Microsoft weiterentwickelt
2012 wurde das Projekt von Eric Woodruff übernommen und weitergeführt bei GitHub: github.com/EWSoftware/SHFB
HintergrundDie 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 (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.
Langjährige Erfahrungen bei der Entwicklung von Desktop-, Web- und Mobilanwendungen sowie dem Betrieb von Software geben die Top-Experten von www.IT-Visions.de gerne an Sie weiter.
Sie brauchen Unterstützung bei der Entwicklung Ihrer Software? www.IT-Visions.de entwickelt Ihre Anwendungen oder einzelne Module und übergibt Ihnen den Quellcode mit Dokumentation.
Ihren Entwicklern oder Admins fehlt es an Know-how und Erfahrung?
Ihr Projekt läuft nicht wie geplant? Oder Sie wollen schon im Vorhinein verhindern, dass es zu Problemen kommt? Unsere Experten sind für Sie da (vor Ort oder per Webkonferenz)!