4.3 Kommentare

Wie wir bereits sehen, verlieren wir bei etwas längerem Code schnell die Übersicht, was die Funktion macht. Daher sollten wir unbedingt den Funktionen einen Text zufügen, der nicht vom Interpreter verarbeitet wird. Solch ein Text wird durch ein #-Zeichen eingeleitet und darf sich nur bis zum Zeilenende erstrecken. Wenn mehrere Zeilen nötig sind, muss erneut das Kreuz gesetzt werden.

Eine gute Kommentierung beschreibt die einlesenden Namen und das was zurückgegeben wird und natürlich die Aufgabe der Funktion. Grundsätzlich sollte eine Funktion immer nur eine einzige Aufgabe ausführen und nicht mehrere auf einmal! Eine gute Kommentierung sieht damit so aus:

>>>def input(a,b,c,d)

... #Weist jeder Zeile die Werte a,b,c,d in dieser Reihenfolge zu.

... #Gibt die mit dem Zeilenindex multiplizierten Summen 

... #der letzten beiden Zeilen zurück

...

...  suma=sumb=0

...  for i in range (4):

...    feld[i]=[a,b,c,d]

...    if i==2:

...     for j in range(4):

...       suma=suma+i*feld[i][j]

...    elif i==3:def input(a,b,c,d)

... #Weist jeder Zeile die Werte a,b,c,d in dieser Reihenfolge zu.

... #Gibt die mit dem Zeilenindex multiplizierten Summen 

... #der letzten beiden Zeilen zurück

...

...  suma=sumb=0

...  for i in range (4):

...    feld[i]=[a,b,c,d]

...    if i==2:

...     for j in range(4):

...       suma=suma+i*feld[i][j]

...    elif i==3:

...     for j in range(4):

...       sumb=sumb+i*feld[i][j]

...  return (suma,sumb) 

...     for j in range(4):

...       sumb=sumb+i*feld[i][j]

...  return (suma,sumb) 

Natürlich hat am Eingabeprompt ein Kommentar keine Wirkung. Daher wird in naher Zukunft auch der Pythonprompt weggelassen, da der Code inzwischen so anwächst, dass Module schon fast zwingend sind. Im Albauf des Verstehens sind Module noch nicht an der Reihe, aber vielleicht lesen Sie doch schon einmal das sehr kurze Kapitel , um sich die doch allmählich aufwändige Arbeit am Eingabeprompt zu ersparen.