DocProject vs Sandcastle Hilfedatei-Generator-GUI
Ich habe mehrere C# - Projekte zusammen mit internen Bibliothek-Komponenten, die ich versuche zu dokumentieren, zusammen. Sandcastle scheint der Ort zu gehen, um die Dokumentation zu generieren von C#. Ich würde gerne wissen, welche der beiden, DocProject oder Sandcastle Help File Builder GUI ist besser und unterstützt die Funktionen, die ich brauche.
Ich würde gerne kompilieren nur die einzelnen Projekte, die Teil des Dokuments und dann haben es alle gemeinsam integriert in die Ende. (d.h. die Bibliothek-Komponenten in einem Dokumentations-Projekt, und jedes Projekt in einem eigenen Dokumentations-Projekt, dann werden alle der oben in einen einzigen Stamm mit Hilfe 2 Betrachter)
InformationsquelleAutor der Frage Nathan | 2008-11-26
Du musst angemeldet sein, um einen Kommentar abzugeben.
Kann ich bürgen für Sandcastle Help File Builder. Es funktioniert wirklich gut, und Sie dokumentieren können, eine beliebige Anzahl von Baugruppen innerhalb einer Sandcastle Help File Builder-Projekt". In der Theorie könnten Sie eine Builder-Projekt und generieren ein doc für jede C# - Projekt, und dann haben Sie einen master Builder-Projekt, welche Dokumente alles.
InformationsquelleAutor der Antwort Ben Griswold
Hier sind einige nützliche links für Sandburg basiert .NET-Dokumentation:
Tutorial auf Sandcastle
Sandcastle Help File Builder (SHFB)
Tutorial auf SHFB
Web-Projekt-Dokumentation
Anleitung how to-Dokument Web-Projekte (Mehr Handbuch und ich glaube, veraltet in Anbetracht der Tatsache, das link)
MSDN-Referenz für die XML-Dokumentation
InformationsquelleAutor der Antwort Gavin Miller
Habe ich nicht verwendet DocProject aber es scheint wie ein Produkt mit Funktionen vergleichbar mit Sandburg.
Habe ich verwendet Sandburg und ich finde es ein effektives Werkzeug. Sie müssen auch Sandcastle Help File Builder (SHFB), um Ihnen eine gute front-end, wie andere hier erwähnt haben. Außerdem müssen Sie die Sandcastle Stile für Präsentations-layer-patches auf dem Sandcastle-Motor. Während alle drei dieser Komponenten musste eine neue Version Mitte 2010, ich bin die Verschiebung der Aktualisierung von der Version 2008 aufgrund einer rendering-Mangel in Firefox 3.6 (dokumentiert in der 2010.09.06 Eintrag Mangel melden).
Habe ich dokumentiert meine Erfahrungen mit der Plattform zu beschreiben, die Frage und eine Vielzahl von anderen, die Sie brauchen können oder wollen, zu betrachten, um zu produzieren, eine saubere, professionelle Dokumentation. In meinem Artikel "Die Zähmung Sandburg: Eine .NET Programmer ' s Guide to Dokumentieren Sie Ihren Code" wurde soeben veröffentlicht auf Simple-Talk.com im September 2010; es kann sparen Sie Sie einige Zeit, Mühe und Qual :-).
InformationsquelleAutor der Antwort Michael Sorens
Doc-Projekt produziert mehr Poliert docs - wenn es funktioniert - das ist nicht die ganze Zeit. Es ist ein viel mehr flakey Produkt.
Sandcastle Help File Builder ist solide und bekommt den job zu erledigen.
InformationsquelleAutor der Antwort Tekdream