Am 14. September 2017 haben wir eine überarbeitete Fassung unserer Datenschutzrichtlinie veröffentlicht. Wenn Sie video2brain.com weiterhin nutzen, erklären Sie sich mit diesem überarbeiteten Dokument einverstanden. Bitte lesen Sie es deshalb sorgfältig durch.

Grundlagen der Programmierung: Codemetriken

Anteil der Kommentare (CLoC)

LinkedIn Learning kostenlos und unverbindlich testen!

Jetzt testen Alle Abonnements anzeigen
Dieses Video klärt, weshalb Kommentare mit Vorsicht zu genießen sind und wie man diese messen kann.
03:25

Transkript

Kommen wir zum Anteil der Kommentare an der Gesamtanzahl von Codezeilen, beziehungsweise den sogenannten Commented Lines of Code. Auf dem Blumentopf steht Kürbis oder Zucchini. Als ich meinen Onkel gefragt habe, was das tatsächlich ist, meinte er, das sei ein Tomatenbaum. Ich weiß nicht, ob das stimmt, ich weiß nicht, was ein Tomatenbaum ist, aber ganz offensichtlich ist der Kommentar, der dort unten auf dem Blumentopf steht, falsch. Und das ist eine Situation, die wir leider viel zu oft im Quellcode vorfinden, Kommentare, die veraltet sind, Kommentare, die uns nichts sagen. Aus diesem Grund sollte man mit Kommentaren vorsichtig sein. Wenn man vorgibt, dass Kommentare da sein sollen, dann erreicht man häufig bloß, dass diese generiert werden, wie hier im Fall. Dort wurde mit dem Tool GhostDoc anhand des Namens der Methode ein Kommentar generiert. Dieser ist nicht hilfreich und erfüllt einfach nur eine Metrik. Auf die Weise betrügen wir uns quasi selbst. Häufig hat man aber auch Kommentare, die einfach nur aussagen, was sowieso im Code drin steht. Wenn hier drin steht, dass man den Button disabled, indem man alle nötigen Properties setzt, dann sieht man das, wenn man bloß den Ausschnitt des Codes sich ansieht. Warum also den Kommentar schreiben? Dieser wird nicht angepasst, falls der Code-Block sich ändert. Viel einfacher wäre es, wenn wir das Ganze in eine Methodik gießen. Der Methodenname sagt dann aus, was darin passiert und macht den Code auf die Art und Weise wiederverwendbar. Der Code muss uns immer sagen, wie etwas passiert, denn das, was im Code steht, ist auch das, was letztendlich passiert. Alles, was wir um den Code drumrum schreiben, altert. Es ändert sich nicht, während das Wie sich tatsächlich ändert. Und aus diesem Grund sollten Kommentare sich darauf beziehen, warum sich etwas verhält, wie es sich verhält, warum etwas geschrieben ist, wie es geschrieben ist. Man muss also mit Code-Metriken rund um die Kommentare etwas vorsichtig sein. Man kann nicht sagen, dass es so und so viele Zeilen Kommentare geben soll. Der nächste Aspekt ist nämlich auch, dass gerne einfach Kommentare geschrieben werden können, die zum Beispiel Code auskommentieren, Code entfernen. Das wird gern von Personen gemacht, die ungern Code löschen, weil sie den ja eventuell noch brauchen. Wenn wir jetzt einfach sagen würden, so viele Zeilen müssen Kommentare sein in unserem Code, dann kriegen wir ein Problem, weil das Volumen des Quellcodes insgesamt durch die Kommentare aufgeblasen wird, ohne dass wir einen Mehrwert davon haben. Aus diesem Grund gibt es die Regel der Commented Lines of Code, also der Anteil der Kommentare an dem Gesamtvolumen unseres Quellcodes. Und das ist einfachste Prozentrechnung, die aussagt, dass wir im Schnitt zwischen 20% und 40% unseres Quellcodes als Kommentare haben sollten. Das ist eine Vorgabe, wie sie aus dem Paper "The fine Art of Commenting" stammt. Ich persönlich tendiere eher zu den 20%, wenn nicht sogar weniger, Kommentaren. Nichtsdestotrotz können Sie auf die Art und Weise schon mal einschätzen, ob Sie zu viele oder zu wenige Kommentare haben. Grundsätzlich sollten Sie aber vermeiden, Quellcode einfach nur auszukommentieren, damit Sie ihn nicht löschen müssen. Dafür gibt es Quellcode-Verwaltungssysteme. Die Qualität von Kommentaren selbst wird auf die Art und Weise nicht eingeschätzt, weswegen die Metrik mit Vorsicht zu genießen ist.

Grundlagen der Programmierung: Codemetriken

Lernen Sie Methoden, Prinzipien und Werkzeuge kennen, mit deren Hilfe Sie die Qualität Ihrer Software dauerhaft sicherstellen können.

1 Std. 43 min (20 Videos)
Derzeit sind keine Feedbacks vorhanden...
 
Exklusiv für Abo-Kunden
Erscheinungsdatum:25.04.2017

Dieser Online-Kurs ist als Download und als Streaming-Video verfügbar. Die gute Nachricht: Sie müssen sich nicht entscheiden - sobald Sie das Training erwerben, erhalten Sie Zugang zu beiden Optionen!

Der Download ermöglicht Ihnen die Offline-Nutzung des Trainings und bietet die Vorteile einer benutzerfreundlichen Abspielumgebung. Wenn Sie an verschiedenen Computern arbeiten, oder nicht den ganzen Kurs auf einmal herunterladen möchten, loggen Sie sich auf dieser Seite ein, um alle Videos des Trainings als Streaming-Video anzusehen.

Wir hoffen, dass Sie viel Freude und Erfolg mit diesem Video-Training haben werden. Falls Sie irgendwelche Fragen haben, zögern Sie nicht uns zu kontaktieren!