Jeder Kommentar ist eine potenzielle Lüge

Kommentare sind ein fester Bestandteil in der Dokumentation von Programmen. Ich kenne genügend Kollegen, die anderer Meinung sind und Kommentare mit Hilfe sprechender Variablennamen ersetzen wollen. Das Ziel des Handelns ist immer das Gleiche. Falls nach genügend Zeit jemand den Code wieder anfassen muss, soll dieser ohne weitere Hilfsmittel erkennen, was mit den vorliegenden Zeilen bewirkt werden soll.

Wie kann ein vorliegender Code die Zielvorgaben darstellen?

Meiner Meinung nach gar nicht. Der vorliegende Code ist das Ergebnis, jedoch keineswegs die Zielvorgabe. Im besten Fall decken sich Vorgabe und Ergebnis. Ich stütze meine Behauptung, dass das Programm niemals ein Garant für die Darstellung der Zielvorgabe ist, auf die Erkenntnis, dass jedes Programm mit wachsender Komplexität fehleranfälliger wird. Das Ergebnis weicht somit unweigerlich von der Zielvorgabe ab.

Welche Aufgabe kommt den Kommentaren zu?

Die besten Kommentare sind diejenigen, die die Ziele des Codes wiedergeben und dabei unterstützend den Code erklären. Wichtig ist dabei immer, in den Kommentaren so genau und ehrlich wie möglich zu sein. So viel wie nötig und so wenig wie möglich, ist hierbei die Devise. Zu wenige Kommentare bergen die Gefahr des Informationsmangels. Zu viele Kommentare können die wichtigen Informationen in Geschwafel untergehen lassen. Die optimale Menge an Kommentarzeilen lässt sich kaum in Prozentzahlen angeben. Wenn jedoch nach spätestens zehn Zeilen Code keine unterstützende Kommentarzeile kommt, werde ich skeptisch.

Beim Troubleshooting helfen Kommentare das Programm zu verstehen. Sie sind somit ein Leitfaden durch oftmals viele hundert Zeilen lange Module. Gute Kommentare helfen einen Fehler zu finden. Jeden Monat gehen tausende Zeilen Code durch die Hände von Programmierern. Es ist so gut wie unmöglich sich alles zu merken. Wissen ist, wenn man weiß, wo es steht. Besser ist es, wenn man noch nicht einmal suchen muss und man in den Kommentaren das Wichtigste nachlesen kann, selbst wenn es nur ein Hinweis auf die Stelle in der Dokumentation ist.

Wenn ein Kommentare das Ziel vorgibt, wie kann er dann lügen?

Software ist lebendig. Dies ist spätestens an den Versionsangaben zu erkennen. Mit jeder Version werden jedoch nicht nur neue Features hinzugefügt, sondern auch alte Programmteile überarbeitet, angepasst oder gelöscht. Dies führt dazu, dass sich die Vorgaben von schon erstellten Modulen sich ändern können. Wird dabei alter Code angefasst, so muss sich dies auch in den Kommentaren widerspiegeln. Da in der Softwareentwicklung meist die Funktion vor der Dokumentation steht, kann es vorkommen, dass Kommentare nicht mehr zum Code und den Zielvorgaben passt. Lüge ist hier zwar ein hartes Wort, weil sie immer eine Intension zur Falschaussage beinhaltet. Die fehlerhafte Darstellung ist jedoch im Programm manifestiert.

Nichtsdestotrotz sind Kommentare wichtige Bestandteile in Programmen, die jedoch mit Bedacht eingesetzt und auf jeden Fall gepflegt werden müssen.

©2018 | www.klaus-sucker.de | Template von www.on-mouseover.de/templates/