Leser Eric O stöberte im Quellcode einer API für Nebenläufigkeit und stieß auf ein bezeichnendes Missverhältnis zwischen Dokumentation und Realität bei einer Status-Property.

Der XML-Dokkommentar über der Property erklärt ernsthaft, der Status sei privat: Das Objekt selbst müsse ihn setzen können, Konsumenten dürften ihn aber nur lesen, damit nicht alles kaputtgeht. Die Deklaration direkt darunter ist jedoch öffentlich — mit öffentlichem Getter und öffentlichem Setter, der bei geändertem Wert lediglich eine PropertyChanged-Benachrichtigung auslöst, verglichen mit dem Backing Field _status.

Der Artikel räumt ein, dass das in der Praxis vermutlich funktioniert und der Kommentar immerhin in der generierten Dokumentation auftaucht — als sanfter Hinweis, dass der Setter tabu ist. Die Pointe liegt in der zugrunde liegenden Annahme: dass die Nutzer der API diese Doku tatsächlich lesen — oder sich daran stören, dass ein schlicht öffentliches Mitglied bloß behauptet, privat zu sein.