live documenter
v2.1.53
Lassen Sie keine Kommentare in Ihrem Quellcode verschwinden! Lesen Sie es, durchsuchen Sie es und veröffentlichen Sie es mit Live Documenter. Dokumentation für .NET leicht gemacht.
Live Documenter ist eine Suite von Anwendungen und Bibliotheken, die die Live-Anzeige und automatische Generierung von Dokumentation aus .NET-Code und XML-Kommentardateien ermöglichen. Erfahren Sie auf unserer Homepage, was Live Documenter ist, und laden Sie die neueste Version herunter.
Sehen Sie sich die Dokumentation live und aktuell an!
Erstellen Sie eine schöne statische Dokumentation.
Oder nutzen Sie die API-Bibliothek zur Integration in Ihre eigenen Projekte.
Der Live Documenter ist eine Desktop-Anwendung, ein Konsolendienstprogramm und eine API-Bibliothek, die Ihren .NET-Code und Ihre Kommentare lesbarer und verfügbarer machen sollen. Befreien wir sie von den Beschränkungen des XML-Codes, der in Ihrem Quellcode verstreut ist, und nutzen Sie sie sinnvoll!
Laden Sie zunächst die neueste Version herunter und lesen Sie die Kurzanleitung.
Mit der Desktop-Anwendung können Visual-Studio-Projekte, -Lösungen oder -Bibliotheken live geöffnet und aus den XML-Kommentardateien eine Dokumentation dazu generiert werden. Wenn Änderungen an der Codebasis vorgenommen werden, werden diese bei der Neuerstellung des Projekts in der Anwendung berücksichtigt.
Es bietet auch eine schöne Schnittstelle zum Exportieren, Lesen und Drucken von Dokumentationen.
Die Exporter-Anwendung eignet sich zur Integration der Dokumentationserstellung in bestehende Prozesse. wie zum Beispiel Ihre Build-Skripte oder das Erstellen einer Ad-hoc-Dokumentation.
Eine DLL, auf die Projekte verweisen können, um zur Laufzeit automatisch Dokumentation zu generieren. Einzelheiten zur API und deren Verwendung finden Sie in der Dokumentation.
Dies funktioniert derzeit nur unter Windows. Es wird derzeit daran gearbeitet, auf Netstandard zu übertragen und alles außer der Desktop-Anwendung plattformübergreifend auf .NET Core zu machen.
Eine ZIP-Datei der neuesten Version wird bereitgestellt. Laden Sie zur Installation die Datei herunter, entpacken Sie sie und führen Sie sie aus den Verzeichnissen aus.
Anforderungen
.NET Core SDK 3.1
Der neueste Code wurde in Visual Studio 2019 bearbeitet und einige der Projekte wurden in Netstandard-Bibliotheken übertragen und verwenden das neueste csproj-Dateiformat.
Bitte lassen Sie mich wissen, wenn beim Erstellen aus dem Quellcode Probleme auftreten, damit ich diese beheben kann.
Jede Hilfe wird geschätzt. Es gibt eine zugehörige Dokumentationsseite, die jederzeit verbessert werden kann.
Wenn Sie sich am Projekt beteiligen möchten, schauen Sie sich bitte die aktuellen Themen an. Notieren Sie Ihr Interesse, holen Sie sich die neueste Version und erstellen Sie eine Pull-Anfrage, wenn Sie bereit sind, die Änderungen zusammenzuführen.
Auch die einfache Bereitstellung von Feedback über GitHub Issues trägt dazu bei, dass das Projekt stabiler wird und ständig weiterentwickelt wird.
