Nach dem Buch (Kapitel 4): „Clean Code – Refactoring, Patterns, Testen und Techniken für sauberen Code“ von Robert C. Martin.
„Kommentieren Sie schlechten Code nicht – schreiben Sie ihn um.“
(Brian W. Kernighan und P.J. Plaugher)
Kommentare können beides sein, hilfreich und hinderlich:
- hinderlich, wenn Sie überholt sind und Fehlinformationen liefern
- störend, wenn Sie zu lang sind und unnötig
- hilfreich, wenn Sie wohlplatziert sind
Der Einsatz von Kommentaren „soll unsere Unfähigkeit ausgleich, uns in unserem Code klar auszudrücken“(S.85). Bevor man einem Kommentar schreibt, sollte man vorher überlegen, ob der Code nicht noch ausdrucksstarker geschrieben werden könnte.