DocProject vs Sandcastle Help File Builder GUI
https://stackoverflow.com/questions/319632
-
11-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
Ich habe mehr C # Projekte zusammen mit einigen internen Bibliothekskomponenten, die ich versuche, zusammen zu dokumentieren. Sandcastle scheint den Ort zu gehen Dokumentation von C # zu generieren. Ich möchte, welche der beiden, DocProject oder Sandcastle Help File Builder GUI besser wissen ist, und unterstützt die Funktionen, die ich brauche.
Ich möchte nur kompilieren jeweils Projekte Teil des Dokuments besitzen, und dann haben sie alle zusammen am Ende integriert. (Das heißt die Bibliothekskomponenten in einem Dokumentationsprojekt und jedes Projekt in einem eigenen Dokumentation Projekt, dann alle der oben in einer einzigen Wurzel des Hilfe-2-Viewer)
Lösung
Ich kann für Sandcastle Help File Builder bürgen. Es funktioniert wirklich gut und Sie eine beliebige Anzahl von Baugruppen innerhalb eines Sandcastle Help File Builder-Projekt dokumentieren. Theoretisch könnten Sie ein Builder-Projekt haben und ein Dokument für jedes C # Projekt generieren und haben dann ein Master Builder-Projekt, das alles dokumentiert.
Andere Tipps
Hier sind einige nützliche Links für Sandcastle basierte .NET-Dokumentation:
Sandcastle Help File Builder (SHFB)
Tutorial auf SHFB
Web Projektdokumentation
Tutorial, wie man Web-Projekte dokumentieren (Mehr Handbuch und ich veraltet glauben vorherigen angesichts der Link)
Ich habe verwendet DocProject nicht, aber es scheint wie ein Produkt mit Fähigkeiten vergleichbar mit Sandcastle.
habe ich verwendet Sandcastle und ich es ein wirksames Instrument finden. Sie müssen auch Sandcastle Help Builder Datei (SHFB), um Ihnen einen guten Front-End, wie andere erwähnt haben Hier. Darüber hinaus müssen Sie Sandcastle Styles für die Präsentation-Layer-Patches auf dem Sandcastle Motor . Während alle drei dieser Komponenten eine neue Version Mitte 2010 hatte ich Upgrade wegen eines Rendering-Fehler in Firefox 3.6 aus dem Jahr 2008 Release bin verschieben (in der 2010.09.06 Eintrag dieser Fehler Bericht ).
Ich habe meine Erfahrungen mit der Plattform gründlich dokumentiert, dass die Ausgabe beschreibt, und eine Vielzahl von anderen, die Sie brauchen oder wollen, können zu prüfen, um einen ordentlichen, professionelle Dokumentation Satz zu erzeugen. Mein Artikel " Taming Sandburg: ein Leitfaden .NET-Programmierer Ihren Code Dokumentieren "wurde gerade veröffentlicht auf
Doc-Projekt produziert mehr poliert docs - wenn es funktioniert - das ist nicht die ganze Zeit ist. Es ist ein viel flakey Produkt. Sandcastle Help File Builder ist fest und bekommt den Job zu erledigen.
