Zurück zum Tagungsprogramm

Inhalt

Doc-as-Code meint oft, dass die Dokumentation wie Quellcode in einem Versionskontrollsystem verwaltet wird und ähnliche Prozesse durchläuft wie der Code. Inhaltlich bleiben beide getrennt. Wir gehen einen Schritt weiter und schreiben die Dokumentation direkt im Code. Anhand einer Datenformatspezifikation zeigen wir, wie wir zusätzlich zu Code-Kommentaren Konzepte, Beispiele und Verarbeitungsregeln in Markdown-Syntax direkt im Code erstellen.

Das lernen Sie

Wie lässt sich Dokumentation direkt in den Quellcode integrieren. Was sind die Vor- und Nachteile einer Docs-im-Code-Lösung, u.a. im Vergleich mit XML-basierter Dokumentation.