Kommentieren und Dokumentieren

Es ist wichtig seinen Code immer zu dokumentieren bzw. wenigstens zu kommentieren, weil man sonst eventuell in einem Jahr nicht mehr recht weiß, was der Code eigentlich mal gemacht hat, warum er funktioniert hat oder ob er überhaupt noch genutzt wird.

Kommentieren

Python sieht alles, was hinter einen # steht als Kommentar an. Zum Beispiel wird folgende Zeile nicht ausgeführt:

#print "Hallo du da!"

Es gibt verschiedene Möglichkeiten Ihre Programme zu kommentieren; zum Einen könnten Sie jede Zeile mit einem Kommentar versehen, was sichtlicherweise ziemlich überdimensioniert wäre. Sie können aber auch bestimmte Schleifen, Bedingungen oder Funktionen mit einem Kommentar versehen:

# addiert zwei Zahlen
def ganzSchwereFunktion(a,b):
    return a+b;

Dokumentationstools

Um das Dokumentieren für den Programmierer etwas einfacher zu gestalten, gibt es Tools, die nach bestimmten Kommentaren suchen und diese Kommentare dann in (z.B eine PDF-) Datei schreiben. So können Sie eine Dokumentation der Funktionalität anbieten ohne Dritten den Code zeigen zu müssen - denn oftmals reicht es bereits zu wissen, was die Funktion tut - man muss nicht immer den darunter liegenden Code kennen um das zu verstehen.

FIXME