Verständlichen Code schreiben

David Amos schreibt hauptberuflich Dokumentationen für Software. Er gehört somit zu den ersten Betroffenen, wenn es darum geht, kryptischen Code zu entziffern. In einem Blogbeitrag gibt er einprägsame Tipps, wie man verständlichen Code formuliert, der Kollegen und das eigene Gehirn in ein oder zwei Jahren nicht vor Verständnisprobleme stellt.

Ausgangspunkt von David Amos' Überlegungen, ist "The Rule of Six", die besagt, dass das menschliche Gehirn, genauer das Kurzzeitgedächtnis und das "Working Memory", lediglich vier bis sechs Dinge gleichzeitig speichern kann. Enthält eine Code-Zeile mehr Informationen, so wird sie für Konfusion sorgen.

Als Beispiel für eine zu komplexe Zeile bringt Amos folgenden Python-Code:

map(lambda x: x.split('=')[1], s.split('?')[1].split('&')[-3:]) 

Wie Amos diese Zeile lesbarer macht, steht in seinem Beitrag.