Kommentare — sparsam, präzise, ehrlich
Schlechte Kommentare:
- Wiederholen, was der Code sagt (
// erhöhe i). - Erklären schlechten Code statt ihn zu fixen.
- Kommentar lügt, weil Code geändert wurde.
- Auskommentierter Code (löschen — git hat das Vorgängerstadium).
Gute Kommentare:
- WARUM wichtig (nicht WAS): „Workaround für IE11‑Bug #4232".
- Hidden Constraints: „Reihenfolge muss alphabetisch sein, weil API erwartet es".
- Public API Docs (JSDoc, Doxygen).
- Warnings: „Diese Funktion ist NICHT thread‑safe!".
- TODO / FIXME mit Ticket‑ID (TODO #ABC‑123: refactor when X).
Zurück zu Informatik