Sandcastle - immer noch das Richtige? Oder gibt es Alternativen? [abgeschlossen
https://stackoverflow.com/questions/986741
-
13-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
Ich frage mich nur - die letzte Veröffentlichung von Sandburg ist ab Mai 2008 und ist immer noch als Pre-Release-Software/CTP aufgeführt und ist nicht einmal mehr lizenziert, wie die EULA ausdrücklich sagt:
2. TERM. Die Laufzeit dieser Vereinbarung ist bis zum 1. September 2007 oder kommerzielle Veröffentlichung der Software, je nachdem, was zuerst ist.
Da Sandcastle sowieso eher "schwer" ist, frage ich mich nur, ob es immer noch das Richtige ist oder ob es Alternativen gibt, um XMLDOC -Dokumentation zu erstellen? (Alternativen = etwas, das ich von meinem Build ausgehen kann, um mindestens HTML zu generieren, vorzugsweise auch PDF).
Lösung
Niemand erwähnte DOCU, ein kürzlich von James Gregory initiierter Projekt, Dev Lead bei Fluentnhibernate.
Es ist ein sehr einfaches und einfach zu verwendendes Tool, das HTML -Dokumentation a la generiert RDOC. Sie können Vorlagen leicht ändern, da docu verwendet wird Funke als Ansichtsmotor.
Hier ist der Fließende Dokumentation von fluentnhibernate mit docu gebaut.
Andere Tipps
Microsoft Sandcastle ist definitiv immer noch der richtige Weg. Die Hauptalternative (die alles in der Nähe des Feature -Satzes von Sandcastle bietet) ist Ndoc, Aber die letzte Veröffentlichung davon ist viel älter und im Januar 2005!
Obwohl es technisch immer noch in der (späten) Stufe vor der Veröffentlichung ist, ist es in der Tat ein ziemlich stabiles Werkzeug. Die geringe Anzahl von Fehlern wurde durch Patches behoben, die auf Codeplex als Teil der verfügbar sind Sandcastle Styles Projekt. Es gibt auch eine hervorragende GUI dafür, nämlich Sandcastle Help File Builder.
Ich bin mir jedoch nicht sicher über die zukünftige Entwicklung von Sandcastle. Ich glaube, es ist wahrscheinlich, dass Microsoft irgendwann die Arbeit/Expansion weiterhin weiterhin weiterentwickelt, obwohl es keine Neuigkeiten zu geben scheint, wann. Es ist sicherlich das einzige anständige Instrument zum Erstellen einer ordnungsgemäßen Dokumentation für eine .NET -Bibliothek oder -Anwendung. Natürlich können Sie oft mit mehr "leichten" Tools für kleine Projekte/Hilfedateien entkommen. Die wichtigsten Alternativen, die mir aufgefallen sind, sind sowohl kommerziell als auch sandkastle minderwertig.
Die Erzeugung von Dokumentationen von Hand/Verwendung benutzerdefinierter Automatisierung ist in bestimmten Fällen wahrscheinlich machbar, jedoch nur für kleine Projekte (die wahrscheinlich nicht erweitert werden.)
Soweit mir weiß, ist Sandcastle immer noch eine gültige Wahl. Ich habe es in der jüngeren Vergangenheit oft verwendet und habe keine Probleme. Sie können diese Seite auf MSDN überprüfen und zum Abschnitt "Dokumentation" nach unten scrollen, um weitere gute Auswahlmöglichkeiten zu erhalten:
Um Sandcastle effektiv zu verwenden, benötigen Sie, wie Noldorin zuvor betonte, auch Sandcastle Styles und Sandcastle Help File Builder (SHFB). Sie hatten alle eine neue Veröffentlichung Mitte 2010, also sind definitiv aktuelle Werkzeuge.
Selbst mit der von SHFB bereitgestellten sauberen und einfachen GUI gibt es jedoch eine ganze Reihe von Problemen, die Sie möglicherweise benötigen, um einen ordentlichen, professionellen Dokumentationssatz zu erstellen. Mein Artikel ("Taming Sandcastle: A.NET -Programmierhandbuch zum Dokumentieren Ihres Code") Dokumentieren meiner Erfahrungen mit einer Vielzahl potenzieller Fallstricks, die auf veröffentlicht wurden Einfache talk.com Im September 2010 kann man sparen Sie Einige Zeit, Mühe und Qual :-).
Eine weitere hilfreiche Ressource: Im Oktober 2010 verfolgte ich den Artikel mit einem einseitige Wanddiagramm Dies fasst das XML -Dokumentationskommentar -Lexikon für SHFB zusammen.
DocProject ist es wert, einen Blick anzusehen. Es nimmt den Schmerz, mit Sandcastle zu arbeiten.
Ich habe eine kurze Liste einiger Dokumentationstools in diese Frage gestellt:Jeder, der ndoc-or-a-similar-tool wird
Ich denke Welchen Wert könnte es Ihnen bringen.
