Wie gut könnt ihr sehr schnell etwas ändern wenn eine Methode geschrieben wurde ohne das irgendwer es für nötig gefunden hat
zu erklären woher z.B. eine
GUID (in Intrexx Standard und in Delphi auch verfügbar)stammt?
Kann sein das man die
GUID schnell findet aber ich wünsche viel Vergnügen beim Suchen wenn die
GUID zerschossen wurde...
Dann hat man das unschöne Vergnügen folgende Dinge zu tun:
- Denn ersteller Suchen
- Denn gesammten SourceCode durchsuchen
- Die gesammte Applikation durchgehen
Bei kleinen Sachen ist das ja nicht unbedingt ein grosser Aufwand aber wenn man eine Komplexe
Applikation vor sich hat würde man sich Wünschen man könnte nur dem Beschrieb vom Kommentar folgen
Versteh nicht, was du meinst.
Zitat:
Von daher ist niemand Perfekt aber ein Code komplett ohne Kommentar zu erstellen ist ein (schwer)Verbrechen
Ich würde es anders sagen: Es sollte das Ziel sein, Code zu schreiben, der keines Kommentars bedarf. Allerdings ist das ein Ziel, das quasi nie vollständig zu erreichen ist.
Zitat:
"Ja 'CreateForm' mit 'Creates a Form' zu dokumentieren, ist heute blödsinnig, aber Kommentare leben und ein existierender Kommentar wird eher erweitert, als ein nicht vorhandener" Die Argumentation stieß auf Zustimmung
Ein falscher Kommentar ist schlechter als ein nicht vorhandener. Zuerst wirst du in die Irre geleitet, produzierst Bugs und verplemperst Zeit. Dann fängst du an, den Kommentaren zu misstrauen und prüfst alles selbst nach. Das aber macht die Kommentare wiederum wertlos, weil alles selbst nachprüfen, kannst du auch ohne Kommentare. Deshalb ist es wichtig, dass Kommentare gepflegt werden.
Je mehr Kommentare da sind, desto mehr Arbeit ist es sie zu pflegen und desto weniger wird es gemacht. Deshalb ist es nicht gut, unnötige Kommentare zu haben. Zudem: Wenn du nur eine Stelle hast, die du nicht selbsterklärend machen konntest, sodass dort ein Kommentar nötig ist, dann wird dieser eine Kommentar herasusstechen. Man merkt gleich: "
Oh, das ist eine komplizierte Stelle, da muss ich aufpassen, wenn ich was ändere und ich muss den Kommentar lesen und ggf. anpassen". Wenn du überall Kommentare hast, hast du diesen Effekt nicht.
Kommentare sind wie Antibiotika. Wenn du sie brauchst, sind sie gut und helfen dir. Es ist aber keine gute Idee, präventiv täglich welche zu nehmen, wenn man sie nicht brauchst. Kommentare sind nicht inhärent gut. Sie sind ein manchmal nicht zu umgehendes Übel.