Quelle: dotnetpro
Projektdokumentation 16.03.2020, 00:00 Uhr

Immer up to date

Mit drei Tools lässt sich der aktuelle Code eines Projekts jederzeit auf Stand dokumentieren.
Ein Projekt dokumentieren und diese Dokumentation dann immer aktuell halten – das gehört zu den eher ungeliebten Aufgaben eines Entwicklers. Doch dabei können die drei Tools/Erweiterungen DocFX [1], Markdown [2] und der JavaScript-Taskrunner Gulp [3] in trauter Dreisamkeit für Visual Studio eine Projektdokumentation erstellen. DocFX erstellt jedes Mal beim Kompilieren automatisch eine Quellcode-Dokumentation; Markdown erlaubt es, eine lesbare Readme-Datei zu schreiben; der JavaScript-Taskrunner Gulp schließlich kopiert bei jedem Build die Readme-Dateien aus den verschiedenen Projekten in die Quellcode-Dokumentation. Diese drei Tools kann der Entwickler nutzen, um jederzeit über eine aktuelle Projektdokumentation zu verfügen.

Ein Beispielprojekt

dotnetpro

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt dotnetpro-plus-Kunde
  • 2 Monate Gratis testen
  • Über 4.000 qualifizierte Fachartikel
  • Auf jedem Gerät verfügbar