Die Rubrik „Representative Line“ von The Daily WTF zeigt einen Dokumentationskommentar, eingereicht von Leser Mark W., entdeckt in einer Codebasis, die er als ansonsten sehr gut geschrieben und über 100.000 Zeilen umfassend beschreibt.
Der komplette XML-Doc-Kommentar der betreffenden Funktion lautet: „Does something wonderful.“ Das ist die gesamte Spezifikation — keine Parameter erklärt, kein Verhalten beschrieben, nur das Versprechen von Wunder.
Die Kolumne weist auf die Mehrdeutigkeit hin: Ist es „Weihnachtszauber“-wunderbar oder das sarkastisch-trockene „Na, wie wunderbar für dich“? Tonfall überlebt reinen Text nicht, also bleibt künftigen Maintainern nur das Rätseln.
Mark räumt ein, dass die Zeile nicht repräsentativ für die Codebasis insgesamt ist — aber, so der trockene Schluss, sie repräsentiert diesen Abschnitt jedenfalls wunderbar.
Kommentare
Noch keine Kommentare — schreib den ersten.
Starte die Diskussion
Kein Konto, kein Passwort nötig — gib einfach deine E-Mail-Adresse ein, wir senden dir einen einmaligen Anmelde-Link. Beim ersten Mal bist du damit automatisch angemeldet.
Deine Bewertung wird nach der Anmeldung automatisch übernommen.
Schau in dein Postfach
Wir haben einen Anmelde-Link an … gesendet. Öffne ihn auf diesem Gerät — dieser Tab meldet dich automatisch an.
Warte auf deinen Klick …
·