Auf seinem Blog The Old New Thing hat Microsoft-Ingenieur Raymond Chen den Unterschied zwischen einer Pull-Request-Beschreibung und Kommentaren im Quellcode herausgearbeitet. Die PR-Beschreibung ist seiner Ansicht nach eine Momentaufnahme, die dem Code Review selbst dient. Sie ist eine Übung in überzeugendem Schreiben, denn ihre Aufgabe ist es, den Approver davon zu überzeugen, dass die Änderung akzeptiert werden sollte.

Kommentare im Code erfüllen eine andere Rolle. Sie erklären den Code selbst: wie eine Funktion aufgerufen werden soll, welche Voraussetzungen gelten und ähnliches Wissen. Chen nennt diese Information dauerhaft, weil sie auch lange nach dem Merge des Pull Requests nützlich bleibt.

The Register merkt an, dass Commit-Messages in der Diskussion eigentlich ebenfalls einen Platz verdienen. Das Thema trifft einen Nerv, weil KI-Coding-Tools derzeit große Mengen an Pull Requests erzeugen, samt gelegentlich fragwürdiger Annotationen. Der Artikel erinnert an ältere Extreme der Kommentarkultur, von einem Kollegen, dessen C++-Kommentare hauptsächlich aus Entschuldigungen an künftige Maintainer bestanden, bis zu einem anderen, der jede Annotation verweigerte, weil der Code angeblich selbstdokumentierend sei. Eine ehrlichere moderne Anmerkung, so der Autor, könnte lauten: von irgendeinem Coding-Assistenten geschrieben, und niemand weiß, wie das Ganze funktioniert.

Der Beitrag verknüpft die Debatte außerdem mit dem Dauerstreit um Tabs versus Spaces. 2024 hatte der ebenfalls bei Microsoft tätige Veteran Larry Osterman die Position vertreten, dass Tabs sinnvoll waren, als Speicherplatz knapp war, Spaces heute aber die sicherere Wahl sind, weil sie immer funktionieren und konsistent bleiben. Chens eigene Haltung zur Formatierung ist liberaler: Es sei ihm egal, wie jemand seinen Quellcode formatiere. Sein einziger praktischer Rat lautet, umfassende Umformatierungen separat einzuchecken, damit Reviewer nicht unter einem Diff begraben werden, das vor allem aus Style-Guide-Änderungen besteht.

Der Schluss kehrt zu Chens Kernunterscheidung zurück: Die PR-Beschreibung begründet, warum eine Änderung akzeptiert werden sollte, während Code-Kommentare das bewahren, was künftige Programmierer zum Verständnis des Codes brauchen.