Dokumentation von Software

Um den Quelltext eines Programmes auch für nachfolgende Bearbeitung verständlich zu halten , ist eine Dokumentierung unerlässlich. Im einfachsten Fall wird dafür die Kommentarfunktion verwendet, die in jeder Programmiersprache zur Verfügung steht. Des weiteren können verschiedene Dokumentationswerkzeuge verwendet werden, die automatisch Dokumentationsdateien erstellen.

Da die Kommentarfunktion häufig nicht ausreicht um gerade umfangreichere Programme  vollständig zu erläutern, müssen dafür eventuell noch weitere Materialien erstellt werden. Dies kann sowohl in graphischer Form (Diagramme, Skizzen etc.) als auch als Text erfolgen.

Wichtig dabei ist, dass die Dokumentation parallel zur Programmierung stattfindet, damit ein zusätzlicher Mehraufwand vermieden wird und die Dokumentation lückenlos ist.

In den nächsten Unterkapiteln wird anhand folgender Funktion dargestellt, wie Software richtig dokumentiert wird und welche Namenskonventionen eingehalten werden sollen.

funktionA ist bisher nicht aussagekräftig. Bei einem Blick auf die Funktion kann nicht erkannt werden, wofür die Variablen a bis g stehen. Im nachfolgenden Kapitel erlernen Sie die wichtigsten Namenskonventionen.

function funktionA(x)
a=9.81
d=45
b=x/3.6
c=d*pi/180
g=b.^2*(sin(c)).^2/2/a
e=2*b*sin(c)/g
f=b*e*cos(c)

disp(['Die Wurfzeit ist = ' num2str(e)])
disp(['Die Wurfweite ist = ' num2str(f)])
disp(['Die Wurfhoehe ist = ' num2str(g)])