Clean Code Regeln für Kommentare

0
Clean Code Kommentare Regeln

Clean Code Kommentare Regeln

C1: Ungeeignete Informationen

Das sind vor allem Infos, die gar nicht zum Thema passen oder vielleicht sogar Emotional sind. Kommentare sollen ja grundsätzlich dem Leser vom Quellcode an der Stelle weiterhelfen. Hier werden keine Romane oder Ausschweifungen gebraucht. Ähnliches gilt auch für Kommentare von Commits. Ein gutes Beispiel, wie man es nicht macht, sind hier die Commits from hell.

C2: Überholte Kommentare

Einer der größten Nachteile von Kommentaren ist das diese nicht mit überarbeitet werden und so ihren Mehrwert verlieren. Moderne IDEs, wie PhpStorm, können die Kommentare ebenfalls mit aktualisieren. Das ist besonders wichtig bei Kommentaren zu Methoden. Hier bietet es sich an direkt mit einem Php Codestandard zu arbeiten und das so direkt in PhpStorm hervorheben zu lassen.

C3: Redundante Kommentare

Redundanz ist in Quellcode immer sehr schlecht. Und bei Kommentaren doppelt unnötig. Das ist ein sehr seltener Anwendungsfall, der mit in den vielen Jahren als Clean Code und Lead Developer auch so noch nicht unter gekommen ist.

C4: Schlecht geschriebene Kommentare

Rechtschreibfehler oder auch andere Sprachen als Englisch haben in Kommentaren nichts verloren. Dazu sollen sie kurz und aussagekräftig sein. Sie sind ein Hilfsintrument für Codestellen, die sich nicht von selber erklären. Allerdings ist das auch ein Hinweis auf schlechten Quellcode. Und das hat einfach keinen Stil, den stehen zu lassen und dann noch zu kommentieren. Das würde man ja in anderen Lebenssituationen auch nicht tun.

C5: Auskommentierter Code

Eine der schlimmsten Comments Smells ist auskommentierter Quellcode. Den traut sich selten

Fazit zu Clean Code Regeln Kommentare

Geht man nach Robert C. Martin – Clean Code darf man im Quellcode gar keine Kommentare verwenden. Das begründet er auch sehr gut. Quellcode, der Erklärungen braucht ist kein Clean Code. Daher muß mehr Energie in den Code fließen. Code muß lesbar sein. 90% seiner Zeit verbringen Coder mit lesen des Codes. Schlechter Code – Legacy Code – wird von schlecht lesbar zu schlecht wartbar. Und das ist mit extrem hohen Kosten beim Bugfixing verbunden.

About Author

PHP Kurs und Inhouse Schulungen für Webdevelopment mit Continuous Integration - Clean Coder, Blogger, Autor, Dozent und Senior Webdeveloper www.rolandgolla.de

Leave A Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.