Den Code einer Funktion schnell verstehen

Als Software-Ingenieur arbeitet Jonathan Boccaraseit mehr als zehn Jahren an großen Code-Basen und hat seither gelernt, aussagekräftigen Code zu schreiben. In einem aktuellen Blogbeitrag erklärt er, wie man den Code einer (Legacy-)Funktion schnell verstehen kann. Er vergleicht dabei das Lesen von Code mit dem Lesen in einem Buch. Auch ein Buch sollte man – sofern es kein Roman ist – nicht von Anfang bis Ende und Zeile für Zeile lesen, sondern nach zunächst einmal nach Stellen suchen, welche den Inhalt zusammenfassen und den Weg zu den individuell relevanten Abschnitten weisen. Umgesetzt auf des Lesen und Verstehen einer Legacy-Funktion bedeutet das, sich zunächst den Anfang und das Ende einer Funktion anzuschauen. Der Name der Funktion verrät – sofern er gut ausgewählt wurde – was die Funktion tun soll. Am Ende einer Funktion findet man in der Regel so etwas wie ein Return-Statement, welches Aufschluss darüber gibt, was die Funktion zurückliefert. Manchmal genügt das allerdings nicht, womöglich gibt es mehrere Return-Statements oder die Funktion ändert sogar globale Variablen ... aber lesen Sie selbst.