.Net XML-Kommentar in API-Dokumentation

Question

Gibt es eine einfache Möglichkeit, MSDN-style-Dokumentation aus der Visual Studio XML-Ausgabe zu erstellen?
Ich bin nicht geduldig genug, um ein gutes xslt dafür zu gründen, weil ich weiß, dass ich nicht die erste Person bin, die diese Brücke überquert.

Außerdem habe ich vor kurzem versucht, Sandcastle einzurichten, aber es hat mich wirklich in die Augen getrieben. Entweder habe ich dabei etwas Wichtiges übersehen oder es ist einfach viel zu aufwendig.

Ich weiß jemand da draußen hat eine wirklich nette tot-einfache Lösung.

Ich wiederhole hier, weil ich meine Formatierung denke, dass Absatz nicht einladend lesen gemacht:

Ich habe Sandburg einen Versuch, aber hatte eine wirklich harte Zeit es bis zu bekommen. Was ich wirklich vorhabe ist etwas viel einfacheres.

Das ist, es sei denn, ich verstehe nur nicht den Sandburg-Prozess. Es schien mir eine Menge Extragepäck zu sein, nur um etwas Schönes für die Tester zu produzieren.

Answer 1

Sie suchen nach Sandcastle

Projekt Seite: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET verwendet das Werkzeug der Wahl zu sein, aber Unterstützung ist so gut wie beendet.

Answer 2

Werfen Sie einen Blick auf Sandcastle, die genau das tut. Es ist auch eine der einfacheren Lösungen, und es ist mehr oder weniger das Tool der Wahl, also könnten wir Ihnen auf lange Sicht helfen, Sandcastle einzurichten, wenn Sie angeben, welche Probleme Sie während der Installation hatten?

Answer 3

Ich habe gerade wieder Sandcastle eingerichtet. Versuchen Sie es zu installieren (die Version Mai 2008) und suchen Sie nach SandcastleGui.exe oder etwas Ähnliches (es ist in den Beispielen Ordner oder so).

Klicken Sie auf Assembly hinzufügen und fügen Sie Ihre Assembly oder Assemblys hinzu, fügen Sie beliebige XML-Dokumentationsdateien hinzu (die vom Compiler generierten, wenn Sie diese Option aktiviert haben) und Build.

Es wird einige Zeit dauern, aber das Ergebnis wird die Mühe wert sein. Es wird tatsächlich Sachen von MSDN nachschlagen, so dass Ihre resultierende Dokumentation auch die Klassenvererbung bis hinunter zu System.Object mit Links zu MSDN und so weiter enthalten wird.

Sandcastle scheint auf den ersten Blick etwas kompliziert zu sein, vor allem, wenn Sie es in einem automatisierten Build verwenden möchten, aber ich bin mir absolut sicher, dass es die Mühe wert sein wird.

Werfen Sie auch einen Blick auf Sandcastle Help File Builder, das ist eine etwas erweiterte GUI dafür.

Answer 4

Folgen Sie this simple 5 step article und Sie sind ziemlich fertig. Als Bonus können Sie H2Viewer verwenden, um Html Help 2.x-Dateien anzuzeigen.

Answer 5

Sie sollten auch den Sandcastle Help File Builder verwenden. Es bietet Ihnen eine ndoc-ähnliche GUI zum Generieren von Hilfedateien, so dass Sie nichts von einer Eingabeaufforderung aus tun müssen.

Welcome to the Sandcastle Help File Builder Project

Answer 6

Ich benutze NDoc3