visual studio - .Net XML-Kommentar in API-Dokumentation

Translate

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

Außerdem habe ich kürzlich versucht, eine Sandburg einzurichten, aber das hat mir wirklich die Augen gekreuzt. Entweder hat mir etwas Wichtiges gefehlt oder es ist einfach viel zu kompliziert.

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

Ich wiederhole es hier, weil ich denke, dass meine Formatierung diesen Absatz nicht zum Lesen einlud:

Ich habe es mit Sandburg versucht, aber es fiel mir wirklich schwer, es einzurichten. Was ich wirklich im Sinn habe, ist etwas viel Einfacheres.

Das heißt, es sei denn, ich verstehe den Sandburgprozess einfach nicht. Es schien mir eine Menge zusätzliches Gepäck zu sein, nur um etwas Schönes zu produzieren, mit dem die Tester arbeiten konnten.

This question and all comments follow the "Attribution Required."

Alle Antworten

Translate

Du suchst Sandcastle

Projektseite:Sandcastle-Veröffentlichungen

Blog:Sandburg Blog

NDoc Code Documentation Generator für .NETFrüher war es das Werkzeug der Wahl, aber die Unterstützung hat so gut wie aufgehört.

Quelle
Translate

Schau es dir anSandburg, was genau das tut. Es ist auch eine der einfacheren Lösungen, und es ist mehr oder weniger das Werkzeug der Wahl. Auf lange Sicht könnten wir Ihnen vielleicht beim Einrichten von Sandcastle helfen, wenn Sie angeben, auf welche Probleme Sie beim Einrichten gestoßen sind.

Quelle
Translate

Sie sollten auch den Sandcastle Help File Builder verwenden. Es bietet Ihnen eine ndoc-ähnliche Benutzeroberfläche zum Generieren von Hilfedateien, sodass Sie an einer Eingabeaufforderung nichts tun müssen.

Willkommen beim Sandcastle Help File Builder-Projekt

Quelle
Translate

FolgenDieser einfache Artikel in 5 Schrittenund du bist so ziemlich fertig. Als Bonus können Sie verwendenH2Viewerum HTML-Hilfe 2.x-Dateien anzuzeigen.

Quelle
Translate

Ich habe gerade Sandcastle wieder eingerichtet. Versuchen Sie es zu installieren (Version Mai 2008) und suchen Sie nach SandcastleGui.exe oder ähnlichem (es befindet sich im Beispielordner oder so).

Klicken Sie auf Baugruppe hinzufügen und fügen Sie Ihre Baugruppe oder Baugruppen hinzu, fügen Sie XML-Dokumentationsdateien hinzu (die vom Compiler generiert wurden, wenn Sie diese Option aktiviert haben) und klicken Sie dann auf Erstellen.

Es wird einige Zeit dauern, aber das Ergebniswerdendie Mühe wert sein. Es werden tatsächlich Inhalte von MSDN nachgeschlagen, sodass Ihre resultierende Dokumentation auch die Klassenvererbung bis hinunter zu System.Object mit Links zu MSDN und anderen Elementen enthält.

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

Schauen Sie sich auch anSandcastle Help File Builder, dies ist eine etwas fortgeschrittenere GUI dafür.

Quelle
Translate

ich benutzeNDoc3

Quelle