Während Software entwickelt oder geplant wird, stellen sich diverse Fragen und es werden Entscheidungen getroffen. Oft gibt es das Problem, dass nach vielen Jahren (oder durch einen Wechsel der Entwickler) die ursprüngliche Entscheidung nicht mehr nachvollziehbar oder verständlich ist.
Es gibt in C# die Möglichkeit, den eigenen Programmcode so zu dokumentieren, dass andere Entwickler in ihrer IDE unterstützt werden können. Dieser Artikel zeigt euch wie eine Dokumentation erstellt und in NuGet eingebunden wird.
Vorbereitung In einem vorherigen Artikel habe ich bereits beschrieben, wie Nuget-Projekte erstellt werden . Dieser bietet euch einen schnellen Einstieg, um loszulegen.
Dokumentation schreiben Für die Dokumentation gibt es XML-Kommentare . Ein einfaches Beispiel kann so aussehen:
