PyDay: Über die Schönheit des Codes

Wir wollen nicht darüber streiten, ob Programmcode schön sein muss. Aber dass er lesbar sein sollte, darüber besteht hoffentlich kein Zweifel. Python lässt uns hier ziemlich viele Freiheiten, die wir auch nutzen sollten.

Die Lesbarkeit betrifft verschiedene Aspekte. Einer davon ist die Dokumentation des Codes.

Docstrings

Kommentare (die in Python mit einem # eingeleitet werden und dann bis zum Ende der Zeile gehen) sind auch aus anderen Programmiersprachen bekannt. Dass der Programmcode aber auch über sich selbst Auskunft geben kann, ist sicherlich neu. Dabei helfen ihm sogenannte „docstrings“. Schon in einer der ersten Versionen unseres Programms haben wir so etwas verwendet. Bei dem in dreifachen Apostrophen eingeschlossenen Text unterhalb der Zeile „def main():“ handelt es sich um genau dieses. Die Informationen will ich nun noch ein wenig erweitern:

def main():
    '''
    Beispielprogramm einer Kaffeemaschine
    (siehe http://www.juengling-edv.de/category/pyday)
    '''

Changeset fbee542

Interessant ist nun sicher die Frage, was uns dies nützt. Nehmen wir einfach mal an, wir würden die Kaffeemaschine von einem Kollegen bekommen und wollten herausfinden, was es damit auf sich hat. Abgesehen von einem Blick in den Quellcode könnten wir folgendes in einer Python-Konsole eingeben:

>>> from kaffeemaschine import main
>>> help(main)

Probiere es aus :-)

Es geht sogar noch besser:

>>> import kaffeemaschine
>>> help(kaffeemaschine)

Auf den anderen Aspekt, Codezeilen umzubrechen, komme ich später noch zu sprechen.


SmallInvoice Logo

Ähnliche Artikel:

AuthorChristoph Jüngling

Selbständiger Softwareentwickler und Seminarleiter

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

drei + vier =