Foto: Shutterstock.com

Quellcode verstehen lernen - Tipps

Drucken
Letztes Update am 22.10.2014, 14:19
Den Quellcode verstehen setzt ein Verständnis der benutzten Objekte voraus.

Die Lesbarkeit und Verständlichkeit von Computer Quellcode in den verschiedenen Programmiersprachen und Skriptsprachen weist extreme Unterschiede auf, unabhängig von der Sprache. Im Idealfall gibt es zum Quellcode ein Designdokument, gute Inline-Kommentierung und saubere Codierung. Im schlimmsten Fall ist der Quellcode ein kaum kommentierter, schlecht lesbarer "Spaghetti".

Worauf ist zu achten?

  • Den Quellcode verstehen setzt ein Verständnis der benutzten Objekte voraus.
  • Handelt es sich bei den Objekten einer Funktion um kompliziertere Strukturen, ist der Ablauf der Funktion stark abhängig von deren Inhalt. Bei Bezügen auf externe Variablen ist eine grobe Kenntnis ihrer Werte notwendig.

Tipps zum Verstehen von Quellcode

Notwendige Dokumente für das Verständnis

  • Bei den Softwarefirmen wird vor der Codierung ein Designdokument erstellt, das Aufgabe und Funktionsweise der Funktionen des Computer Quellcodes beschreibt. Im Quellcode gehört zu jeder Funktionsdefinition eine Kommentierung ihrer Aufgabe, ihrer Parameter, der Abhängigkeit von anderen Funktionen und Nebeneffekten.
  • Innerhalb der Funktion beschreiben weitere Kommentare Einzelheiten der Implementierung. Von der Funktion aufgerufene Funktionen sind im Designdokument oder bei der Beschreibung der Bibliotheksfunktionen dokumentiert.

 

Wie komme ich zum Verständnis des Quellcodes?

  • Begonnen wird mit dem Designdokument, sofern eines vorhanden ist. Es beschreibt die Aufgabe der Funktion, die Ein- und Ausgabeparameter und die Logik, den "Algorithmus". Bei modernen Sprachen wie Java kann diese Dokumentation automatisch aus dem Computer Quellcode erzeugt werden.
  • Der nächste Schritt ist ein Durchgehen der Logik des Quellcodes. Sinnvolle Kommentierung, gut gewählte Variablennamen und saubere Formatierung erleichtern den Quellcode zu verstehen. Bei "clean Code" lässt sich der Quellcode fast wie ein Roman lesen, bei dem als Nachschlagewerk immer die Beschreibung der aufgerufenen Funktionen und der globalen Variablen parat sein sollte.
  • Ist der Quellcode nicht so gut geschrieben, muss er in seine Funktionsblöcke aufgebrochen werden und ein Durchlaufen des Quellcodes bei bestimmten Werten zeigt die detaillierte Funktionsweise. Den Quellcode anhand beispielhafter Parameterwerte durchzugehen hilft beim Quellcode verstehen, ist aber bei kompliziert geschachtelten Schleifen nicht immer möglich.
  • Bei Computer Quellcode, der mehrfach parallel durchlaufen werden kann, sogenannter "reentrant" Code, enthält der Quellcode Funktionsaufrufe zum kontrollierten Zugriff der mehrfach gleichzeitig laufenden Funktionen auf Speicherbereiche, auf die nur ausschließlich eine Funktion gleichzeitig zugreifen kann. Dies sind meist systemspezifische Bibliotheksaufrufe. Ein detailliertes Verständnis dieses Quellcodes ist meist nicht notwendig.

Kommentare