Logo Wissenstransfer Gerhard at CichnaDotCom

>> Wissensdatenbank / Clean Code

Kommentare

"Kommentieren Sie schlechten Code nicht - schreiben Sie ihn um."
     - Brian W. Kernighan und P. J. Plaugher

Der angemessene Einsatz von Kommentaren soll unsere Unfähigkeit ausgleichen, uns in unserem Code klar auszudrücken.
Wenn man also einen Kommentar schreiben muss, sollte man vorher überlegen, ob man sich nicht doch noch im Code besser ausdrücken kann.
Je älter ein Kommentar ist und je weiter er von dem Code entfernt ist, den er beschreibt, desto wahrscheinlicher ist er einfach falsch; er verbreitet Lügen und Fehlinformationen.
Ungenaue Kommentare sind viel schlimmer als gar keine Kommentare. Die Wahrheit kann nur an einer Stelle gefunden werden: im Code. Deshalb sollte man, auch wenn Kommentare manchmal erforderlich sind, sich anstrengen, um sie zu minimieren.