16.04.2015, 00:00 Uhr

Kommentare raus, klare Bezeichner rein

Der Simple-Programmer-Blog zeigt an einem echten Beispiel, wie Code durch Entfernen der Kommentare zu besser lesbarem Code werden kann.
Code der erst mit Hilfe von Kommentaren verständlich wird, ist oft Code, dessen Namensgebungen nicht gut sind und dessen Funktionen und Methoden zu viele Aufgaben erfüllen müssen. Und wehe, wenn eine Methode schnell geändert werden muss und man "vergisst" den Kommentar anzupassen. Dann wird der Kommentar sogar irreführend. Steve McConnell hat das Thema in seinem Buch Code Complete thematisiert. Der Simple-Programmer-Blog hat das Thema aufgegriffen und anhand eines Real-World-Beispiels die möglichen Verbesserungen durch ein Refaktoring aufgezeigt.
Alle für einen Zweck konstruierten Beispiele bringen es mit sich, dass sie für den Ausgang der Geschichte maßgeschneidert werden. Dem hier verwendeten Beispiel kann man das allerdings nicht vorwerfen. Es ist ein Stück Code aus dem .NET Framework, das bekanntlich jetzt Open Source ist. Die verwendete Klasse DirectoryFileSplitter hat keinen schlechten Code und auch keinen unverständlichen Code, und auch die eingefügten Kommentare sind sinnvoll. Dennoch zeigt der Beitrag, dass der Code durch Weglassen der Kommentare und Einfügen besser passenderer Bezeichnungen verständlicher wird.



Das könnte Sie auch interessieren