Konventionen Datei

Beim Programmieren existieren gewisse Konventionen. Diese beeinflussen das Programm nicht direkt, sie führen aber dazu, dass der Code einfacher zu lesen und besser austauschbar ist.

Standard-Kopfzeile

Zu Beginn jeder Python-Datei schreiben wir einen mehrzeiligen Kommentar. Dieser beinhaltet folgende drei Punkte:

  • Autor (Wer hat das Programm geschrieben?)
  • Datum (Wann wurde das Programm geschrieben?)
  • Beschreibung (Was macht das Programm?)

Durch so eine Standard-Kopfzeile dokumentieren wir unseren Code. Wenn wir später einmal die Datei öffnen, sehen wir gleich, was wir wann und wieso gemacht haben.

Der folgende Block kann als Standard-Kopfzeilen-Vorlage für eigene Python-Dateien verwendet werden:

"""
Beschreibung
Author
Datum
"""

Dateinamen

Beim Benennen der Datei gilt es folgende Punkte zu beachten:

  • nur Kleinbuchstaben verwenden
  • keine Sonderzeichen
  • keine Leerschläge, sondern _ (underscore)
  • Dateiendung .py
  • aussagekräftiger Name!