Viel zu viele Kommentare???
-
Original erstellt von JFK:
**
Wenn ich 50 Klassen verwenden muß und hab keinerlei Anhaltspunkte, was das passiert, dann bin ich als Programmierer aber wirklich arm dran, wenn ich mich durch alle Methoden durchwühlen muß, bis ich die richtige Gefunden hab.Meiner Meinung nach extrem kurzsichtig gedacht.... oder Du bist so ein Genie, daß du schneller den Code im Kopf in eine Programmdoku umsetzt, also 4 Sätze zu lesen.... Ist aber eher zu bezweifeln.**
Dann bin ich vermutlich ein Genie, da ich mich auch nach Monaten noch ohne Probleme in meinem Programm zurechtfinde. Das besteht momentan aus 185 Klassen mit ähnlicher Kommentierung. Zugegeben: Hin und wieder steht auch ne Zeile Kommentar drin.IMHO ist es klar, was die Methoden machen. Wenn da eine Methode getDerivative steht, dann bringt mir ein Kommentar in der Form "Returns the derivative" auch nichts. Wenn man seinen Methoden natürlich Namen, wie "bmc_ioctl" gibt, dann kommt man nach 2 Wochen nicht mehr ohne weiteres dadrauf, was die Methode macht. Da braucht man dann schon Kommentare.
-
vielleicht kommst Du auch mal in die Lage, etwas zu programmieren, daß Du fachlich nicht so verstehst, oder mit dem Du Dich programmtechnisch nicht so auskennst.
Ich habe bei uns in der Firma mehr als genug Beispiele, wo man alte Programme pflegen muß und immer wieder Stellen findet, die man erstmal in die Fachlichkeit zurückinterpretieren muß. Da wär ich mit Deinem Beispiel schnell am Ende und leider gibt und gab es auch bei uns viele Leute, die es ähnlich wie Du halten, weil es ihnen ja klar ist, was sie machen. Aber wehe, sie wechseln ihre Zuständigkeiten, kündigen, gehen in Rente oder kriegen nix mehr auf die Reihe...
Aber wie gesagt. Ich kann nur aus meiner Sicht schildern, wie ich es für mich persönlich ok finde. Ich programmiere auch nicht erst seit vorgestern und jeder macht seine eigenen Erfahrungen.
-
Original erstellt von JFK:
vielleicht kommst Du auch mal in die Lage, etwas zu programmieren, daß Du fachlich nicht so verstehst,Wenn du dich fachlich nicht in dem Gebiet auskennst, helfen auch keine Kommentare. Die brauchen schließlich auch eine Basis, auf der sie aufsetzen.
-
Natürlich tun sie das. Aber meistens kommt man eher von der fachlichen Seite zum Programm und nicht umgekehrt. Weil die fachliche Sache kann ich jemanden relativ schnell grundlegend erklären. Ein Programm hingegen nicht. Außerdem kann jemand, der sich fachlich auskennt, aber das Programm nicht kennt, viel schneller verstehen, um was es da gerade gehen soll.
Ich glaube, daß war auch generell der Grundgedanke von Kommentaren...
Insofern hab ich zu dem Thema jetzt genug geschrieben. Will hier ja niemanden missionieren. Jeder soll sich sein Himmel- oder Höllenreich selber schreiben...
-
Gregor - stell dir mal vor, du fängst in einer Firma an. Du kriegst ein begonnenes GP System vor die Nase gesetzt. ( GP = Genetic Programming )
Du sollst es erweitern, oder Teile ändern.Wenn das Ding nicht richtig Kommentiert ist, bist du ein armes Schwein. Mit Glück ist vielleicht noch die Person da, die den Code geschrieben hat, mit Pech, hat er gekündigt oder ähnliches, und du stehst als armes Würstchen vor X Klassen, die unkommentiert sind.
Du wirst ihn Verfluchen. Wenn´s kommentiert ist, findest du dich viel schneller zurecht
-
Real Programmers don't comment their code. If it was hard to write, it should be hard to understand.