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?
Antwort
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:
- Eric Woodruffs Sandcastle Help File Builder Documentation (SHFB Creator)
- C# Programming Guide: Recommended Tags for Documentation Comments (MSDN)
- Wm. Eric Brunsen der XML Documentation Comments Guide (Dynicity)
- Anson Horton XML Documentation in C# (Microsoft C# Compiler Program Manager)
- 1. Gibt es eine gute Anleitung zum Entschlüsseln von SSL-Datenverkehr?
- 2. Gibt es eine Python-Bibliothek zum Generieren von .ico-Dateien?
- 3. Gibt es eine Bibliothek zum Generieren von ods/xlsx-Dokumenten?
- 4. Gibt es eine Emacs Lisp-Bibliothek zum Generieren von HTML?
- 5. Wie msdn Dokumentation von Javascript generieren? vorzugsweise mit Sandcastle
- 6. Gibt es eine gute Dokumentation zum PDF-Parsing in Swift?
- 7. Gibt es eine gute C-Implementierung von Google Protocol Buffers
- 8. Gibt es eine Option zum Generieren von Gerüsten, ohne Migrationen zu generieren?
- 9. Gibt es gute Ressourcen zum Interpretieren von Linux-Leistungsindikatoren?
- 10. Gibt es Werkzeuge oder Projekte zum Generieren von AZW-Dateien?
- 11. Gibt es ein Tool zum Generieren von Flussdiagramm aus Code?
- 12. Django: Ist es eine gute Idee, JS dynamisch zu generieren?
- 13. Gibt es ein Tool zum Generieren von DTOs aus Entitäten?
- 14. Gibt es eine gute Python-GUI-Shell?
- 15. pyxmpp: Kurzanleitung zum Erstellen eines Muc-Clients?
- 16. Gibt es eine gute WPF-Pivot-Steuerung?
- 17. Gibt es eine gute Diagrammbibliothek für Python?
- 18. Gibt es ein Eclipse-Plugin zum Generieren von Entwurfsmustern?
- 19. Gibt es Werkzeuge zum Generieren von Klassendiagrammen für Python-Quellcode?
- 20. Gibt es in PHP eine gute (eigenständige) PHPDoc-Parser-Klasse?
- 21. Gibt es eine gute Referenz für die Datenbindungssyntax von SharePoint?
- 22. Gibt es eine gute Alternative zu WebSVN?
- 23. Gibt es eine gute J2ME IDE?
- 24. iPhone SDK Kurzanleitung
- 25. Gibt es eine Möglichkeit, xsd.exe zum Generieren von Klassen mit "internem" Geltungsbereich zu erhalten?
- 26. Gibt es gute Bücher zum Schreiben kommerzieller Software?
- 27. Gibt es eine Website zum Nachschlagen von Barcodes?
- 28. Gibt es eine gute .NET-Version von DelphiFeeds.com?
- 29. Gibt es eine Möglichkeit, Ints mit i zu generieren?
- 30. gibt es ein Sandcastle-Plugin für Visual Studio 2010?