Gibt es eine gute Kurzanleitung zur Erzeugung von API-Dokumentation mit Sandcastle?

Question

Ich werde docs API Sandcastle zu erzeugen, - ich noch keine Guides, wie dies zu tun auf dort Website finden konnte. Hat jemand irgendwelche Schnellstartanleitungen sie empfehlen würden?

Answer 1

Ich würde vorschlagen, mit SHFB (wenn Sie können), da es es macht wirklich einfacher. SHFB mit Dokumentation kommt, aber Sie werden ohne Tutorial gemeinsame Funktionen nutzen können, es ist.

Answer 2

Ich bin auch eine starke Unterstützung von SHFB , so sehr, dass im September 2010 einen beträchtlichen Beitrag geschrieben auf Sandcastle und SHFB den Titel Taming Sandburg: ein Leitfaden .NET-Programmierer Ihren Code zu Dokumentieren wobei ich beschreiben Tipps zur Verwendung und eine Menge der möglichen Gefahren eines wahrscheinlich zu begegnen ist. Im Oktober 2010 wurde ich, dass mit Sandcastle Help File Builder Dokumentation (SHFB Creator)

C # -Programmierhandbuch: Empfohlene Tags zu Dokumentation Kommentare (MSDN)

Wm. Eric Brunsen XML Kommentare zur Dokumentation Leitfaden (Dynicity)

XML-Dokumentation des Anson Horton in C # (Microsoft C # Compiler Program Manager)

Answer 3

Vielleicht könnten Sie überprüfen (Codeplex) Website von Sandcastle. Aber meine Erfahrung ist, dass es am besten ist, nur mit ihm zu spielen, um. Das erste, was Sie tun müssen, ist Ihre Anwendung so konfigurieren, dass Ihre Kommentare in eine XML-Datei zu generieren (und XML-Kommentare in Ihrem Code verwenden). Dies ist eine Einstellung in Ihrem Projekt.

Die nächste, was Sie tun können, die Assembly mit der zugehörigen XML in Sandcastle ist geladen und mit den Einstellungen (in den meisten Fällen sind die Standardeinstellungen sind gut genug) spielen. Die meisten Einstellungen sind selbsterklärend oder liegen auf der Hand, indem du den Namen suchen.

Viel Glück mit ihm zu spielen!