comments-smells

A Comments smell occurs when a method, class, or block is filled with explanatory comments — not because the logic is genuinely complex, but because the code structure itself is unclear. Comments in this context act like a deodorant: they mask fishy code rather than fixing it.

"The best comment is a good name for a method or class."

Comments are not inherently bad — but when they're needed to explain what the code does (rather than why a design decision was made), that's a signal to refactor.

Erkennen, erklären und beheben Sie „Kommentar“-Codefehler – Fälle, in denen übermäßige oder erklärende Kommentare darauf hinweisen, dass der zugrunde liegende Code einer Umgestaltung statt einer Annotation bedarf. Verwenden Sie diese Fähigkeit immer dann, wenn der Benutzer Code mit umfangreichen Kommentaren teilt, nach Best Practices für Kommentare fragt, eine Codeüberprüfung mit Schwerpunkt auf Lesbarkeit wünscht, fragt „Sind meine Kommentare zu umfangreich?“, Codegerüche erwähnt oder die Klarheit des Codes verbessern möchte. Wird auch ausgelöst, wenn der Benutzer Code einfügt und fragt, wie er sauberer, selbstdokumentierender oder verständlicher gestaltet werden kann – auch wenn er den „Kommentargeruch“ nicht ausdrücklich erwähnt. Quelle: bsene/skills.