News
  • Abwesenheit

    Vom 02.06.2017 bis 25.06.2015 ist das Ingenieurbüro nicht besetzt. Ich bleibe per Email erreichbar, mit einiger Verzögerung.

Dokumentation

Softwareentwicklung » Dokumentation

Softwaremodule, die unbesehen verwendet werden sollen, müssen textuell dokumentiert werden. Um hier Redundanzen zu vermeiden, wird die textuelle Dokumentation direkt in den Quelltext eingebettet. Mit der Software Doxygen lassen sich dann ansprechende html, chm oder pdf-Dateien erzeugen. Da jede Funktion, jeder Funktionsparameter und jede Datenstruktur direkt bei ihrer Definition auf dokumentiert wird, ist die Dokumentation tendenziell aktueller als ein seperat gepflegtes Dokument.