.NET XML-Kommentar in API-Dokumentation

stimmen
15

Gibt es eine einfache Möglichkeit , MSDN-Stil - Dokumentation aus der Visual Studio XML - Ausgabe zu produzieren?
Ich bin nicht geduldig genug , eine gute Xslt dafür einzurichten , weil ich weiß , ich bin nicht die erste Person , diese Brücke zu überqueren.

Auch habe ich versucht, Sandburg vor kurzem der Einrichtung, aber es ist wirklich meine Augen Kreuz gemacht. Entweder ich fehlte etwas Wichtiges im Prozess oder es ist einfach viel zu verwickelt.

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

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

Ich gab einen Versuch Sandburg aber hatte eine wirklich harte Zeit, es einzurichten. Was ich wirklich im Auge ist etwas viel einfacher.

Das heißt, es sei denn ich die Sandburg Prozess einfach nicht verstehen. Es schien wie ein schrecklich viel zusätzliches Gepäck mir nur etwas Gutes für die Tester zu produzieren, mit zu arbeiten.

Veröffentlicht am 03/08/2008 um 23:03
quelle vom benutzer
In anderen Sprachen...                            


6 antworten

stimmen
9

Sie suchen nach Sandcastle

Projektseite: Sandcastle Releases

Blog: Sandcastle Blog

NDoc - Code - Dokumentation Generator für .NET verwendet das Werkzeug der Wahl zu sein, aber die Unterstützung aller , aber zum Stillstand gekommen ist.

Beantwortet am 03/08/2008 um 23:12
quelle vom benutzer

stimmen
5

Sie sollten auch die Sandcastle Help File Builder verwenden. Es bietet Ihnen eine ndoc wie GUI zum Erzeugen von Hilfedateien, so dass Sie nicht alles von einer Eingabeaufforderung zu tun haben.

Willkommen in der Sandcastle Help File Builder-Projekt

Beantwortet am 19/09/2008 um 16:22
quelle vom benutzer

stimmen
5

Werfen Sie einen Blick auf Sandburg , die genau das tut. Es ist auch eine der einfacheren Lösungen gibt, und es ist mehr oder weniger das Werkzeug der Wahl, so auf lange Sicht, vielleicht können wir Ihnen helfen , Sandcastle einrichten, wenn Sie angeben , was Sie während der Installation auftreten Probleme?

Beantwortet am 03/08/2008 um 23:14
quelle vom benutzer

stimmen
3

Folgen Sie diesen einfachen 5 Schritt Artikel und Sie sind ziemlich viel getan. Als Bonus können Sie verwenden H2Viewer Html Help 2.x - Dateien anzuzeigen.

Beantwortet am 04/08/2008 um 11:31
quelle vom benutzer

stimmen
3

Ich habe gerade wieder Sandburg eingerichtet. Versuchen Sie es (der Mai 2008 Veröffentlichung) und die Suche nach SandcastleGui.exe oder etwas ähnliches (es ist in den Beispielen Ordner oder so) zu installieren.

Klicken Sie auf Assembly hinzufügen und Ihre Versammlung oder Baugruppen hinzufügen, fügen Sie alle XML-Dokumentationsdateien (die vom Compiler generiert, wenn Du diese Option aktiviert ist) und dann bauen.

Es wird einige Zeit dauern, aber das Ergebnis wird die Mühe wert sein. Es sieht tatsächlich Sachen von MSDN, also Ihre resultierenden Dokumentation wird auch die Klassenvererbung den Weg nach unten mit Links zu MSDN und Sachen zu System.Object alle hat.

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

Auch einen Blick auf haben Sandcastle Help File Builder , ist dies eine etwas fortgeschrittenere GUI für sie.

Beantwortet am 04/08/2008 um 11:27
quelle vom benutzer

stimmen
2

Ich benutze NDoc3

Beantwortet am 21/02/2010 um 23:12
quelle vom benutzer

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more