Dokumentation

Sourcecode verstehen - Zusammenhänge erkennen

Für IDUS ist die Dokumention der erstellten Softwareprogramme, speziell die Quellcode-Dokumentation ein zentraler Bestandteil der Programmierung. Dabei werden die fachlich und technisch relevanten Kommentare in standardisierter Form direkt im Quellcode hinterlegt. Bei nachträglichen Änderungen im Quellcode kann der Entwickler die bestehende Dokumentation sofort ergänzen und an neue Gegebenheiten anpassen. Dies führt zu einem gemeinsamen Verständnis technischer und fachlicher Zusammenhänge innerhalb einzelner Softwaremodule und erleichtert die Servicearbeiten im Zuge der Softwarewartung.

 

Standardisierte Quellcode-Dokumentation:

  • Datum und Versionsnummer der Änderung
  • Kurze Beschreibung der Funktionalität
  • Schnittstellen und Besonderheiten
  • Fachlich relevante Begriffe und Zusammenhänge
  • Ablaufdiagramme

 Dokumentationsbeispiel im Sourcecode

Mit speziellen Tools werden diese Quellcode-Kommentare extrahiert und zu einem verlinkten HTML-Dokument zusammengefasst. Ergänzt um anschauliche Ablaufdiagramme bilden diese Dokumentationen eine wesentliche Grundlage für den Know-how-Transfer unserer Softwareprojekte. So entsteht Schritt für Schritt ein Wissen über Programme und Branchen auf das bei der nachfolgenden Weiterentwicklung unserer Softwaremodule zurückgegriffen werden kann.