Ich werde API-Dokumente mit Sandcastle generieren - ich konnte keine Anleitungen finden, wie man das auf der Website macht. Hat jemand eine Kurzanleitung, die er empfehlen würde?Gibt es eine gute Kurzanleitung zum Generieren von API-Dokumenten mit Sandcastle?
Ich würde vorschlagen, SHFB (wenn Sie können), wie es es wirklich einfacher macht. SHFB wird mit Dokumentation geliefert, aber Sie können die allgemeinen Funktionen ohne Tutorial verwenden.
Vielleicht könnten Sie die (Codeplex-) Seite von SandCastle überprüfen. Aber meine Erfahrung ist, dass es am besten ist, damit herumzuspielen. Als Erstes müssen Sie Ihre Anwendung so konfigurieren, dass sie Ihre Kommentare in eine XML-Datei generiert (und XML-Kommentare in Ihrem Code verwendet). Dies ist eine Einstellung in Ihrem Projekt.
Als nächstes können Sie Ihre Assembly mit dem zugehörigen XML in Sandcastle laden und mit den Einstellungen spielen (in den meisten Fällen sind die Standardeinstellungen gut genug). Die meisten Einstellungen sind selbstdokumentierend oder durch den Blick auf den Namen offensichtlich.
Viel Glück beim Spielen!
Ich bin auch eine starke Unterstützung von SHFB, so sehr, dass ich im September 2010 einen beträchtlichen Artikel über Sandcastle und SHFB mit dem Titel Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code geschrieben habe, in dem ich Anwendungstipps und viele mögliche Fallstricke schildere. Im Oktober 2010 folgte ich diesem Thema mit einer one-page wall chart, die das XML-Dokumentationskommentar-Lexikon für SHFB zusammenfasst.
Aus meiner Forschung für den Artikel, hier ist die komplette Liste der andere nützliche Ressourcen: