Programmcode kommentieren – warum ist es so wichtig?

Ich denke, dass so ziemlich jeder Programmierer seine Programme schon mal in irgendeiner Weise kommentiert hat. Doch wie konsequent? Und vor allem, wieso überhaupt die Mühe? Genau das ist der Punkt, den ich euch näher bringen möchte.

In meinen Augen – und das habe ich jetzt erst Recht noch durch die Ausbildung gelernt – ist kommentieren absolut unverzichtbar. Speziell für mich ist es wichtig, da ich bald wieder 4 Wochen in der Schule bin (Blockunterricht) und ich vorerst nichts mit meinen Programmen zu tun haben werde. Doch wie soll ich nach 4 Wochen Schule noch wissen, was ich wo genau gemacht habe und vor allem wieso? Das ist ein wichtiger Grund, der für das Kommentieren spricht.

So brauche ich nach diesen 4 Wochen  nicht den kompletten Programmcode durcharbeiten, sondern mir lediglich meine Kommentare durchlesen. So weiß ich wieder zu fast 100% was ich gemacht habe und die restlichen Prozente kommen auch nach kurzer Zeit wieder.

Ein zweiter Grund für das Kommentieren ist folgender: Wenn man in einer Abteilung arbeitet und man nicht der Einzige ist, der an diesem Programm arbeitet, so ist es durchaus wichtig, dass sich andere schnell mit dem Programmcode zurechtfinden und ihn ändern oder erweitern können. Problematisch ist es nämlich, wenn man z.B. im Urlaub ist und etwas am Programm geändert werden muss, aber ein anderer Mitarbeiter erstmal eine Woche benötigt, um überhaupt zu verstehen, was gemacht wurde und wieso. Und dies verkürzt sich durch Kommentieren auf wenige Stunden, wenn nicht sogar Minuten.

Mit Sicherheit gibt es noch weitere Gründe, doch genau diese sind mir besonders aufgefallen.

Sicherlich kommt in Verbindung damit auch die Frage auf, wie viel man kommentieren sollte. Um ehrlich zu sein, kann ich diese Frage nicht beantworten. Man muss einen gesunden Mittelweg finden, aber in der Regel ist es nicht schlimm, wenn man etwas mehr kommentiert. Hauptsache man kann ohne große Probleme den Programmcode nachvollziehen. Das ist die Hauptsache!

Schreibe einen Kommentar

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