Kommentierung

Zwar dürfte die Beispielfunktion mit dem Help-Kommentar recht leicht verständlich sein, dies gilt aber nicht mehr für komplexere Programme.
Es müssen also noch weiter Kommentare geschrieben werden um den Code schnell verständlich zu machen. Hierbei gilt natürlich, dass so viel wie nötig und so wenig wie möglich kommentiert wird.

Um also unsere Funktion so verständlich wie möglich zu machen, werden die einzelnen Rechenschritte nun erklärt:

function Wurfparabel(v)
%Berechnung der Wurfparabel mit der Ausgabe des max. Weges x(t) und der max. Höhe y(t)
%Eingangswert ist die Geschwindigkeit v in km/h
%der Abwurfwinkel beträgt 45°
g=9.81
phi=45
%Umrechung von v in m/s
v_ms=v/3.6
%Umrechung von phi ins Bogenmaß
phi_rad=phi *pi/180
%Berechnung der max. Höhe, Länge und Zeit
wurfzeit=2*v_ms*sin(phi_rad)/g
wurfweite=v_ms*wurfzeit*cos(phi_rad)
wurfhoehe=v_ms.^2*(sin(phi_rad)).^2/2/g
%Ausgabe
disp(['Die Wurfzeit ist = ' num2str(wurfzeit)])
disp(['Die Wurfweite ist = ' num2str(wurfweite)])
disp(['Die Wurfhoehe ist = ' num2str(wurfhoehe)])

Wichtig: Gerade beim Arbeiten im Team kann die Kommentierung über Erfolg und Misserfolg entscheiden. Kommentieren Sie also nicht nachlässig!

 

Es gibt noch eine weitere Möglichkeit über Kommentierung den Zugang zu Ihrem Programm zu erleichtern. Dazu verwenden Sie den sogenannten "section break".

Mit dem section break wird Ihr Programm unterteilt. Überschriften, die Sie in diesen Kommentar schreiben, werden später unter "Details" dargestellt.

Eine beispielhafte Anwendung finden Sie im unterstehenden Code. Schauen Sie sich die Details ihrer m.-Funktion im linken Fenster unter dem Current Folder an.

function Wurfparabel(v)
%Berechnung der Wurfparabel mit der Ausgabe des max. Weges x(t) und der max. Höhe y(t)
%Eingangswert ist die Geschwindigkeit v in km/h
%der Abwurfwinkel beträgt 45°
g=9.81
phi=45
%Umrechung von v in m/s
v_ms=v/3.6
%Umrechung von phi ins Bogenmaß
phi_rad=phi *pi/180
%%Berechnung der max. Höhe, Länge und Zeit
wurfzeit=2*v_ms*sin(phi_rad)/g
wurfweite=v_ms*wurfzeit*cos(phi_rad)
wurfhoehe=v_ms.^2*(sin(phi_rad)).^2/2/g
%%Ausgabe
disp(['Die Wurfzeit ist = ' num2str(wurfzeit)])
disp(['Die Wurfweite ist = ' num2str(wurfweite)])
disp(['Die Wurfhoehe ist = ' num2str(wurfhoehe)])

 

Gerade bei komplexen Programmen kann das Kommentieren sehr mühsam sein. Wenn Sie zum Beispiel einen Inhalt der Funktion auskommentieren möchten, würde jede einzelne Zeile zu kommentieren sehr umständlich sein. Dazu bietet MATLAB Ihnen jedoch eine Vereinfachung.

Mit "Strg + R + auszukommentierender Text" können sie mehrere Zeilen auf einmal auskommentieren.

Natürlich gibt es auch die Möglichkeit den Code danach wieder interpretierbar zu machen und zwar mit "Strg + T + kommentierter Text".

Die Abbildung an der rechten Seite zeig Ihnen das Aussehen der zugehörigen Symbole.