Die Vor- und Nachteile (aber meistens Vor-) von Kommentaren im Code

Bild: scyther5, Getty Images / iStockphoto

Sollten Sie Ihrem Code Kommentare hinzufügen oder nicht? Die Antwort lautet natürlich ja. Es ist auch nein. Oder weniger scherzhaft: "Sie sollten sich zunächst bemühen, Ihren Code so einfach wie möglich zu verstehen, ohne sich auf Kommentare als Krücke zu verlassen. Nur an dem Punkt, an dem der Code nicht leichter verständlich gemacht werden kann, sollten Sie anfangen, Kommentare hinzuzufügen." Jeff Atwood hat das schon 2006 geschrieben, aber es ist heute genauso aktuell wie damals. Vielleicht mehr.

So bauen Sie eine erfolgreiche Entwicklerkarriere auf (kostenloses PDF)

Der Fall gegen Kommentare

Rufen Sie das Thema auf und ausnahmslos (und bald) wird Ihnen jemand sagen, warum Sie Ihren Code nicht mit Kommentaren überladen sollten. Eine der Hauptbeschwerden über Kommentare ist, dass sie dem Signal des Codes Rauschen hinzufügen. "Guter Code ist selbstdokumentierend", heißt es, und das Hinzufügen von Kommentaren kann manchmal dazu dienen, schlechten Code zu maskieren, und nicht zum Besseren. Wie Bennett Garner geschrieben hat:

Das ist schon schlimm genug, aber das Problem verschärft sich mit zunehmendem Alter der Kommentare. Wie Marco Bresciani argumentiert hat: "Glaube nicht an Kommentare: Sie werden nie aktualisiert. Nur der Code sagt die Wahrheit." Kommentare mögen irgendwann nützlich gewesen sein, aber wenn sich der Code ändert (und das ist üblich), tun dies die Kommentare oft nicht. Dadurch bleibt der Code mit veralteten Kommentaren überfüllt, die eher verwirrend als klarstellend sein können. "Idealerweise würden Entwickler ihre Kommentare beim Aktualisieren des Codes aktualisieren, dies ist jedoch in der Regel nicht der Fall.

Natürlich unterstützen die meisten Code-Editoren das Falten von Code, wodurch die Kommentare ausgeblendet werden und Entwickler nur den Quellcode anzeigen können. Dies setzt jedoch voraus, dass Kommentare immer schlecht sind, was nicht stimmt. Wann könnten sie gerechtfertigt sein?

Der Fall für Kommentare

Versuchen Sie so viel wie möglich, Ihren Code "selbstdokumentierend" zu machen. Eines kann Code nicht: Erklären Sie das Warum hinter dem Code. Wie Jef Raskin bemerkt hat: "Der grundlegende Grund, warum Code niemals selbstdokumentierend sein kann und automatische Dokumentationsgeneratoren nicht erstellen können, was benötigt wird, ist, dass sie nicht erklären können, warum das Programm geschrieben wird, und die Gründe für die Auswahl diese oder jene Methode. Sie können nicht diskutieren, warum bestimmte alternative Ansätze gewählt wurden. " Möglicherweise müssen Sie beispielsweise erklären, warum ein nicht intuitiver Weg eingeschlagen wurde, wie Bill Sourour ausführt, um zukünftigen Entwicklern die Mühe des offensichtlicheren (aber falschen) Ansatzes zu ersparen.

Auch hier sollte das Hauptaugenmerk darauf liegen, qualitativ hochwertigen, präzisen Code zu schreiben, der sich (mehr oder weniger) selbst erklärt. Wo dies nicht möglich ist (und es ist nicht immer möglich), "Stellen Sie sich Kommentare als das i-Tüpfelchen vor, das dem Leser Informationen liefert, die nicht einfach durch den Code selbst ausgedrückt werden können", um Brian Hannaways zu verwenden Wörter.

Wichtig ist, fährt er fort, dass es wichtig ist, Ihr Publikum im Auge zu behalten. Es ist eine schlechte Annahme zu glauben, dass diejenigen, die später auf Ihren Code stoßen, über das gleiche Maß an Fachwissen verfügen. Als solches hat er vorgeschlagen, sich um die weniger erfahrenen zu kümmern:

Insgesamt gibt es gute Gründe, Kommentare auf ein Minimum zu beschränken, aber sie machen Kommentare insgesamt nicht überflüssig. Sie benötigen nachfolgende Entwickler, um Ihren Code verstehen zu können: Das beginnt mit dem Schreiben von sauberem, präzisem Code, endet aber mit gerade genug Kommentaren, damit sie verstehen, warum Sie bestimmte Dinge getan haben.

Open Source Wöchentlicher Newsletter

Sie möchten unsere Tipps, Tutorials und Kommentare zum Linux-Betriebssystem und zu Open Source-Anwendungen nicht verpassen. Dienstags geliefert

Heute anmelden

© Copyright 2021 | mobilegn.com