Generieren Sie HTML / Help -Dateien aus VS 2010 C# XML -Dokumentation

StackOverflow https://stackoverflow.com/questions/4781784

Frage

Ich suche ein gutes Tool, das HTML / Help -Dateien aus meiner VS2010 XML -Dokumentation erstellt. Ich habe einige kommerzielle Werkzeuge gefunden, wie z.

Ich bin sicher, es gibt mehr, ich liste diese beiden nur als Beispiele auf. Außerdem gibt es einfache XSLT -Stylesheets, um die XML in HTML -Dokumentation umzuwandeln.

Was verwenden Sie, z. B. gibt es ein kostenloses Werkzeug, um die Konvertierung durchzuführen, möglicherweise als Add-In. Nur um zu verdeutlichen, habe ich im Grunde zwei Arten von Werkzeugen gefunden:

  1. Diejenigen, die die XML -Dokumentationsdatei in verschiedenen Zielformaten konvertieren, suche ich.
  2. Tools, die mir helfen, die XML -Dokumentation im Quellcode zu generieren. Das ist nicht (!) Was ich suche.

Danke für Ihre Hilfe.

Die Sandcastle / SHFB -Combo funktioniert großartig. Vielen Dank an alle, die geholfen haben.

Einige Bemerkungen:

  1. NDOC scheint veraltet zu sein, letzte Updates stammen aus dem Jahr 2005. Deshalb habe ich das übersprungen.
  2. Ein ähnlicher Thread, ebenfalls sehr detailliert, finden Sie hier: https://stackoverflow.com/questions/3082044/how-to--turn-c-xml-doc-comments-into-somthething-useful Danke für den Tipp!
  3. Es gibt einige Quellen für Sandcastle, die neueste Version, die ich gefunden habe, befindet sich hier: http://sandcastle.codeplex.com/
  4. Um zu generieren MsHelp2 Ich musste gegen 2008 SDK -enthalten installieren hscomp.exe. Es gibt eine Version 1.0 und 1.1, soweit ich es herausfinden könnte, enthält Version 1.0 den Compiler. Sehen HelixSoft und Social MSDN für einige Details.
  5. In meinem Fall funktioniert die generierte WebHelp nicht korrekt mit Chrome. Es lädt immer die Seite index.html.
  6. Das Thema hier Zeigt an, wie Sie den Namespace -Infos in Sandcastle -Dokumentation hinzufügen.
  7. Update ab November 2012: Für kleinere Projekte, die ich verwende Doxygen - Ich finde es ein wenig einfacher zu konfigurieren.
War es hilfreich?

Lösung

Wir verwenden Sandcastle für Transformation & Sandcastle -Hilfedatei Builder als Benutzeroberfläche, um die Hilfsprojekte zu verwalten. Meiner Meinung nach ist die Schönheit von Sandcastle und SHFB, dass Sie neben der "durchschnittlichen" Quellcode -Dokumentation zusätzliche Informationen wie Architektur des Programms, Muster hinzufügen können, die befolgt werden müssen, oder zusätzliche konzeptionelle Inhalte für Ihr Projekt, das nicht gebunden ist direkt zu einer Klasse in Ihrem Programm. Dies kann durch Erstellen zusätzlicher XML -Dateien mit Hilfe des Microsoft Authoring -Schemas erstellt werden (kann mit Visual Studio als XML -Datei und dem Schema für es verfügbar sein). Es ist ziemlich einfach, mit diesen Tools zu beginnen, um MSDN -ähnliche Dokumentationen zu erstellen.

Vor langer Zeit habe ich docbook ausprobiert, das auf der technischen Seite nahezu gleich ist (XML -Dateien, die die Informationen und XSLT -Dateien enthalten, um sie in verschiedene Ausgangstypen zu verwandeln). Für uns war es jedoch keine Option, da es keine Transformation gibt, die die von Visual Studio generierte XML -Dokumentation verwenden kann (plus die Transformation von konzeptionellen Inhalten war für uns ziemlich schmerzhaft).

Andere Tipps

Zwei weitere kostenlose Tools, die die Erstellung von Dokumentation aus XML -Kommentaren ermöglichen:

Sandcastle + SHFB ist eine großartige Kombination. Kostenlos und generiert HTML, CHM usw.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top