FreeBasic: Sinnvolle Kommentare

Kommentare

Du weißt schon wie man Kommentare benutzt, aber wie man sie sinnvoll benutzt weißt du vielleicht noch nicht. So sehen immer wieder Quelltexte aus:

print "Hallo"   'Gibt Hallo aus
sleep 1000      'Wartet 1 Sekunde
dim s as string 'Legt Variable i an
input "Name",s  'Liest s ein
print "Hallo "+s'Gibt s aus
sleep           'Wartet auf Tastendruck

Die Kommentare helfen niemandem weil man auch am Befehl selber sieht was er tut. So ist das ganze viel besser:

'Dieser Abschnitt gibt Hallo aus und fragt dann nach dem Namen um zu begrüßen.
print "Hallo"   
sleep 1000      
dim s as string     'Soll den Namen speichern 
input "Name",s  
print "Hallo "+s    'Gibt die Begrüßung aus
sleep

Ein Kommentar über einem Block Anweisungen der beschreibt was in diesem Block passiert. Der Kommentar der Variablen ist ihr Zweck und nicht ihr Name oder ähnliches. Über einer Funktionsdefinition ist ein kleiner Text über den Zweck und die Arbeitsweise der Funktion nicht verkehrt.

Variablennamen

In einem kleinen Programm wie dem oben ist es OK einer Variable Namen wie s oder i zu geben. Aber in normalen Programmen sollte man sich sinnvolle Namen überlegen, die Auskunft über den Zweck der Variablen geben. Namen wie "Blub" oder "hagjh" sind tabu. Du solltest auch in Erwägung ziehen die ungarische Notation oder die Notation für VB zu verwenden. Es ist nicht schwer, aus "dim Zahl as integer" wird "dim iZahl as integer". So kommst du gar nicht erst auf die Idee "iZahl=0.5" zu schreiben, was einen Fehler zur Folge hätte der nur schwer gefunden werden kann.