TODO: Stracciatella im Quellcode

In der Softwareentwicklung sind TODO-Kommentare eine beliebte Methode, um auf noch ausstehende Arbeiten im Code hinzuweisen. Doch was passiert, wenn sich diese TODOs wie Schokosplitter in einem Stracciatella-Eis verteilen und den gesamten Code durchziehen? In diesem Blogbeitrag werfen wir einen genaueren Blick auf diese gängige Entwickler-Gewohnheit, beleuchten die damit verbundenen Probleme und zeigen auf, wie man es besser machen kann – und warum das wichtig ist.

Die Gewohnheit: TODOs als Platzhalter für offene Aufgaben

Jeder Entwickler kennt es: Im Laufe der Entwicklung entsteht Code, der aus verschiedenen Gründen nicht vollständig ist. Möglicherweise handelt es sich um Übergangslösungen, die aufgrund externer Abhängigkeiten notwendig sind, oder um Workarounds, die anstelle einer noch fehlenden Library-Funktion implementiert wurden. Der erste Schritt, diese Stellen im Code durch einen TODO-Kommentar zu kennzeichnen, ist naheliegend und sinnvoll. Doch häufig bleibt es nicht bei einem einzigen TODO. Im hektischen Entwickleralltag können sich solche Kommentare vermehren und geraten dabei oft in Vergessenheit. Manchmal sind sie sogar Überbleibsel aus der Entwicklungsphase eines Tickets, die unbemerkt das Code Review überstanden haben.

Das Problem hierbei: Mit der Zeit entstehen verstreute TODO-Kommentare, die den Code wie ein Stracciatella-Eis durchziehen – kleine, unscheinbare „Schokosplitter“, die auf offene Baustellen hinweisen. Doch was als schnelle Notiz für die Zukunft gedacht ist, kann sich langfristig als problematisch erweisen.

Warum das problematisch ist: Versteckte Baustellen und fehlende Übersicht

TODO-Kommentare haben eine zentrale Schwäche: Sie verbleiben im Code und werden leicht übersehen. Auch wenn sie darauf hinweisen, dass es noch etwas zu tun gibt, geschieht dies oft nur auf Ebene des individuellen Entwicklers. In modernen Entwicklungsprojekten, egal ob agil oder klassisch gemanagt, sind es jedoch nicht die einzelnen Entwickler, die allein entscheiden, was als Nächstes erledigt werden muss. Diese Entscheidungen liegen bei Projektmanagern, Product Ownern oder ähnlichen Rollen, die den Überblick über das gesamte Projekt behalten müssen.

Das Problem ist, dass TODO-Kommentare nicht sichtbar genug für diese Entscheider sind. So bleibt der nötige Raum für Wartungsarbeiten, das Entfernen von Workarounds oder das Auflösen von Abhängigkeiten oft unberücksichtigt. Zudem manifestiert sich ein Problem selten nur an einer einzigen Stelle im Code. Einzelne TODOs schaffen es nicht, größere Zusammenhänge darzustellen, was zu einer unstrukturierten und unvollständigen Bearbeitung von Aufgaben führen kann.

Wie man es besser macht: TODOs strukturieren und sichtbar machen

TODO-Kommentare sind nützlich – aber nur, wenn sie richtig eingesetzt werden. Sobald sich abzeichnet, dass ein TODO-Kommentar über die Implementierung des aktuellen Tickets hinaus Bestand haben wird, sollte ein neues Ticket im Projektmanagementsystem angelegt werden. Dieser Schritt sorgt dafür, dass die offene Aufgabe sichtbar und nachvollziehbar wird. Durch das Anlegen eines Tickets wird ein Anker gesetzt, über den alle TODOs, die sich auf dasselbe Problem beziehen, zugeordnet werden können.

Darüber hinaus sollten TODO-Kommentare immer nach einer einheitlichen Syntax gestaltet werden. So lassen sie sich mithilfe einer IDE schnell und zuverlässig finden. Ein hilfreicher Tipp ist, bereits während der Entwicklung die Ticket-ID direkt im Kommentar zu hinterlegen. Dies erleichtert nicht nur die spätere Kontrolle, sondern beschleunigt auch das Code Review, da die Kommentare sofort im Kontext des entsprechenden Tickets eingeordnet werden können.

Warum das besser ist: Transparenz, Übersicht und Nachverfolgbarkeit

Die strukturierte Handhabung von TODO-Kommentaren verbessert die Transparenz im Entwicklungsprozess erheblich. Durch das Anlegen von Tickets werden offene Aufgaben sichtbar und können in die Projektplanung integriert werden. Das hilft nicht nur den Entscheidern, sondern auch dem gesamten Team, die Übersicht zu behalten. Einzelne TODOs bleiben nicht länger isolierte Hinweise im Code, sondern werden Teil eines größeren Zusammenhangs, der gezielt und systematisch bearbeitet werden kann.

Einheitliche Syntax und die Zuordnung von Ticket-IDs schaffen zudem Klarheit. Entwickler können schneller arbeiten, da sie nicht erst nach den passenden TODOs suchen müssen. Das Code Review wird effizienter, und die Wartung des Codes vereinfacht sich. Insgesamt führt dies zu einer höheren Codequalität, besserer Planbarkeit und letztlich zu einem produktiveren Team.

TODO-Kommentare sollten also nicht wie zufällige Schokosplitter im Code verstreut bleiben, sondern strukturiert und bewusst eingesetzt werden. So kann aus einem anfänglich kleinen Hinweis eine gut dokumentierte und nachverfolgbare Aufgabe werden, die im Team effektiv bearbeitet wird.

Wie werden ToDo’s bei Ihrer Entwicklung gehandhabt?

Ihre Fragen dazu beantwortet unser Head of DevOps gerne:
Kai Rumrich, kai.rumrich@schwarzer.de, Jetzt anrufen: +49 6131 / 30 292 34