Wie man sein Programm kommentieren sollte:
8) Ich finde es immer wieder überraschend, warum so viele Programmierer keine Kommentare zu ihren Bausteinen schreiben. Dabei kann man gerade dort oft mit einem einzigen Wort Klarheit schaffen, worum es im Baustein geht. Dadurch kann man auch noch nach Jahren einfach wieder ins Programm finden. Ich finde das ist ein ordentliches Aufwands/Ergebnis Verhältnis, das sich lohnt.
8) Noch viel überraschender finde ich, dass so viele Leute den Unterschied zwischen Symbol und Kommentar nicht begreifen wollen und sich so viel unnötige Arbeit machen. Da werden dann ganz tolle Symbole kreiert wie z.B.
FL_POS_RB011_EIN
Was hält eigentlich diese Leute davon ab, statt dieser tollen Abkürzung als Symbol, im Kommentar zu schreiben:
Flanke_Positiv_Rollenbahn011_ein
Ich finde das Erstaunlich, vor allen Dingen dann, wenn von vornherein feststeht, dass dieses Programm später übersetzt werden muss. Hätten Sie den Kommentar dahin geschrieben wo er hingehört, müsste niemand wie ein Irrer die Symbol übersetzen, einfach eine Übersetzungsdatei generieren, ab zum Übersetzungsbüro und dann wieder einlesen ist offensichtlich viel zu einfach.
8) Die Netzwerküberschrift wird auch häufig weggelassen. Warum eigentlich? Auch hier kann man wieder mit wenig Aufwand viel Erreichen. Wenn man das Programm nur grob verstehen möchte um eine kleine Änderung vorzunehmen ist dieser kleine Helfer doch wunderbar.
8) Den Netzwerkkommentar blenden sogar viele Programmierer einfach aus. Was ich völlig unverständlich finde. Gerade hier kann man sehr Sinnvolle Sachen rein schreiben, ich persönlich schreibe hier oft rein, was der Kunde so von mir verlangt hatte. Da stehen dann so Sachen drin wie:
Herr K. von Firma X, möchte das ich nicht auf dem Endschalter warte, sondern gleich mit dem Servo weiterfahren um Taktzeit zu sparen. Herr K. ist sich der Risiken bewusst und übernimmt die Verantwortung. Y-Hausen am XX.YY.ZZ
Das mag zwar kein Rechtlich geltender Beweis sein, hat aber schon oft meinen Hintern gerettet.
8) Der Zeilenkommentar, wenigstens der wird manchmal genutzt, oft genug aber selbst der nicht. Das finde ich auch immer wieder richtig toll. Liebe Mitprogrammierer, wenigstens diesen Kommentar sollte man ordentlich führen. Man sollte doch auch noch nach einem Jahr oder so in der Lage sein, sein eigenes Programm zu verstehen.
:!: Eine gute Kommentierung des Programms ist das A und O eines guten Programmierstiles. Sicherlich ist es auch mit Arbeit und Zeit verbunden, aber der Aufwand lohnt sich im jeden fall, ohne wenn und aber. Man kann eigentlich nicht zu viele Kommentare schreiben, je mehr desto besser, eine „Überdokumentation“ gibt es meiner Meinung nach nicht.
