.Net XML-Kommentar in der API-Dokumentation

Question

Gibt es einen einfachen Weg, um zu produzieren MSDN-Stil aus den Unterlagen des Visual Studio XML-Ausgabe?
Ich bin nicht geduldig genug, um ein gutes xslt für es, weil ich weiß, ich bin nicht die erste person, überqueren diese Brücke.

Auch habe ich versucht das einrichten sandcastle vor kurzem, aber es hat wirklich meine Augen überqueren.Entweder war ich etwas wichtiges fehlt in der Prozess-oder ist es nur die Art und Weise zu beteiligten.

Ich weiß, jemand da draußen hat eine wirklich schöne tote-einfache Lösung.

Ich bin erneut hier, weil ich denke, dass meine Formatierung aus, dass der Absatz nicht Einladend zu Lesen:

Ich gab sandcastle versucht, aber hatte eine wirklich harte Zeit, es einzurichten.Was ich wirklich im Sinn haben, ist etwas viel einfacheres.

Das heißt, es sei denn, ich verstehe einfach nicht, der sandcastle-Prozess.Es schien wie eine Menge von extra-Gepäck, nur mit mir zu produzieren, die etwas nettes für die Tester zu arbeiten.

Answer 1

Sie suchen Sandcastle

Projekt-Seite: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET verwendet, um zu werden das Werkzeug der Wahl, aber die Unterstützung hat alle, aber gestoppt.

Answer 2

Haben Sie einen Blick auf Sandcastle, die genau das tut, dass.Es ist auch eine der einfacheren Lösungen, und es ist mehr oder weniger das Werkzeug der Wahl, so dass in die lange laufen, vielleicht könnten wir helfen Sie zu set up Sandcastle wenn Sie angeben, was Probleme, die Sie begegnet während der Installation?

Answer 3

Sie sollten auch die Sandcastle Help File Builder.Es bietet Sie mit eine ndoc wie GUI für die Erzeugung von Hilfe-Dateien, so dass Sie nicht haben, etwas zu tun, von einer Eingabeaufforderung.

Willkommen auf der Sandcastle Help File Builder Project

Answer 4

Folgen dieses einfache 5-Schritt-Artikel und Sie sind so ziemlich fertig.Als bonus können Sie verwenden H2Viewer zum anzeigen der Html-Hilfe 2.x-Dateien.

Answer 5

Ich habe gerade eingerichtet Sandcastle wieder.Versuchen Sie, es (Mai 2008 release) und suchen Sie nach SandcastleGui.exe oder etwas ähnliches (es ist in den examples Ordner oder so).

Klicken Sie auf Hinzufügen, Montage und fügen Sie Ihre Montage-oder Baugruppen hinzufügen .xml-Dokumentationsdateien (die, die vom compiler erzeugt wird, wenn Sie die aktiviert-option) und dann auch Bauen.

Es wird einige Zeit dauern, aber das Ergebnis wird die Mühe Wert sein.Es wird tatsächlich suchen Dinge aus der MSDN-Website, damit Sie die Dokumentation auch die Vererbung ganz nach unten zu System.Objekt mit links zu MSDN und Zeug.

Sandcastle scheint zuerst ein bisschen kompliziert, vor allem, wenn Sie verwenden möchten es in eine automatisierte build -, aber ich bin absolut sicher, es wird die Mühe Wert sein.

Auch haben Sie einen Blick auf Sandcastle Hilfe File Builder, dies ist eine etwas erweiterte GUI dafür.

Answer 6

Ich benutze NDoc3