Zum Inhalt

Kommentare im Code – Fluch oder Segen?

In diesem Blogpost möchte ich gerne auf das Thema Kommentare eingeben. Den Kommentare in Code können Fluch und Segen zugleich sein.
Dabei gibt es einige Regel, nach denen ich Code kommentiere oder auch lieber nicht.

Wenn möglich, vermeide Kommentare

Bevor du einen Kommentar in deinen Code schreibst, überlege wirklich gründlich, ob es dafür keine bessere Lösung gibt. Kannst du durch andere Methoden- oder Variablennamen evtl. auf den Kommentar verzichten? Zerlege zum Beispiel die Methode in mehrere kleine Methoden und benenne diese so, dass der nächste Leser anhand des Methodennamen versteht, was der Code macht. Also versuche mit deinen Methoden und Variablennamen eine Geschichte zu erzählen.

„Kommentieren Sie schlechten Code nicht – schreiben Sie ihn um“ – Brian W. Kernigen & P.J. Plaugher

Erkläre warum/wieso – nicht was der Code macht

Solltest du eine Programmstelle haben, die deiner Meinung nach kommentiert werden sollte. Dann erkläre in deinem Kommentar Warum? oder Wieso? an diese Stelle etwas passiert und nicht was der Code macht. Der Leser sollte sowieso in der Lage sein, den Code zu lesen und zu verstehen. Aber evtl. fehlt ihm das Hintergrundwissen um zu verstehen, warum dieser Code dort implementiert wurde.

Kommentiere keine Codestellen aus

Gerne werden nicht mehr benötigte Codestellen aus kommentiert und bleiben über Jahre im Code bestehen. Später weiß niemand mehr warum die Stelle aus kommentiert wurde und bei späteren Codeanpassungen besteht die Gefahr, dass die Codestelle wieder einkommentiert wird.

Um alten Quellcode zu sichern, sollte man daher nicht die Stellen als Kommentare markieren. Sondern einfach in diesen Fällen gebraucht von einem Versionskontrollsystem machen, wenn man alte Codestände wieder abrufen möchte.

Bei dem obigen Beispiel fragt man sich als Entwickler wurde die Zeile aus kommentiert …

… weil sie überflüssig ist? Falls ja, wieso wurde sie dann nicht gelöscht?

… um etwas zu testen und nur wieder vergessen sie ein zu kommentieren?

Um jede Fehlinterpretation zu vermeiden, empfiehlt es sich nicht mehr benötigten Code zu entfernen. Sollte der Code später einmal wieder benötigt werden, dann einfach die entsprechende Version aus dem Versionskontrollsystem abrufen.

Probleme bei Kommentaren

Ein großes Problem von Kommentaren ist, dass sie mit der Zeit vernachlässigt werden. Bei zukünftigen Programmänderungen wird der Code umgeschrieben aber oft werden dabei die Kommentare nicht mit geändert. Dies führt dazu, dass Kommentare dann schnell verwirren oder nicht mehr der Wahrheit entsprechen, was gerade bei einem Projekt mit mehreren Entwicklern zu Problemen führen kann.

Manche Kommentare sind auch schlichtweg überflüssig. Da der Programmcode in der Regel sowieso nur von Programmieren gelesen wird, müssen Dinge auch nicht kommentiert werden. (z.B. der Konstruktor einer Klasse)

 

Published inC#CleanCode

Schreibe den ersten Kommentar

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.