Gute Dokumentation ist (sehr) wichtig. Undokumentierten Code anderer Menschen zu verstehen macht in der Regel eher wenig Spaß, deshalb wollen wir unseren Code natürlich ganz bestimmt immer ausreichend kommentieren (natürlich auch nach dem Vorkurs). Finden Sie heraus, was folgende (so gar nicht dokumentierte) Funktionen machen und kommentieren Sie entsprechend.
#
eingeleitet."""
eingefasst.In Python gibt es Konventionen zur Struktur von Kommentaren:
Kommentare in einer eigenen Zeile folgen immer der Form:
#[*Ein Leerzeichen*][Kommentar]
Kommentare hinter einer Code-Zeile folgen immer der Form:
[* mindestens zwei Leerzeichen*]#[*Ein Leerzeichen*][Kommentar]
Außerdem sollen Kommentare immer auf Englisch geschrieben werden.
Beispiel:
# Name the best band in the world
beste_band = "Bring me the Horizon" # This is not for debate
def eine_funktion(zahl):
neue_zahl = zahl*zahl
return neue_zahl
def eine_weitere_funktion(zahl):
zahl += 1
neue_zahl = zahl*2
return neue_zahl
def eine_weiterere_funktion(zahl):
i = 3
neue_zahl = 1
while i > 0:
neue_zahl = neue_zahl*zahl
i = i-1
return neue_zahl
def noch_eine_funktion(natuerliche_zahl):
neue_zahl = 1
i = natuerliche_zahl
while i > 0:
neue_zahl = neue_zahl*i
i = i-1
return neue_zahl
def noch_eine_weitere_funktion(zahl):
if zahl < 0:
neue_zahl = zahl*(-1)
else:
neue_zahl = zahl
return neue_zahl