Quellcode Kommentieren

[p80286]

Zitat von Dejan Vu:

...wenn ich in alte Ich-frickel-mir-schnell-Code-zusammen-ist-doch-wurscht-wie-das-aussieht verfalle, verfluche ich nach spätestens drei Erweiterungen mein anfängliches Gewurschtele.

Na, die Erfahrung sollten eigentlich die meisten von uns schon gemacht haben.


Übrigens sind die Namen der Prozeduren beim Erstellen meist sehr einleuchtend und präzise. Nach einem Monat sehe ich das für mich doch etwas kritischer.

Gruß
K-H

[Stevie]

Zitat von p80286:

Zitat von Dejan Vu:

...wenn ich in alte Ich-frickel-mir-schnell-Code-zusammen-ist-doch-wurscht-wie-das-aussieht verfalle, verfluche ich nach spätestens drei Erweiterungen mein anfängliches Gewurschtele.

Na, die Erfahrung sollten eigentlich die meisten von uns schon gemacht haben.

Witzigerweise ist das aber die Argumentation, die ich oft höre, wenn es um sauberen Code, Einhaltung von bestimmten Praktiken etc geht. Für kleine Huschhusch Projekte oder irgendwas, was man nur alleine programmiert, braucht man sowas ja nicht... ja, nee is klar. Wenn man das schon nicht für nen banales Projekt macht und dort lernt, dann wird man das bestimmt bei nem Riesenprojekt perfekt beherrschen.

[OlafSt]

Clean Code lohnt sich auch auf andere, ungewöhnlichere Art:

Noch im letzten Jahrtausend (OMG, wie sich das anhört) schrieb ich eine Applikation, die via GSM-Modem irgendwo Daten abholte, decodierte und in einer SQL-DB verschwinden ließ. ich wechselte die Firma, wechselte die Firma, wechselte die Firma, lag im KH, machte mich selbständig.

Dann klingelt das Telefon - der Kunde von damals möchte ein paar Änderungen an dem Ding haben. 15 Jahre alter D7-Code. Da bist du froh, wenn du sauber gearbeitet und ein paar Kommentare hinterlassen hast.

[himitsu]

Zitat von OlafSt:

Dann klingelt das Telefon - der Kunde von damals möchte ein paar Änderungen an dem Ding haben. 15 Jahre alter D7-Code. Da bist du froh, wenn du sauber gearbeitet und ein paar Kommentare hinterlassen hast.

Kommt drauf an.

Wenn keiner den Code versteht, sondern nur noch du (etwas) und die dann auf dich zu kommen müssen, weil kein Anderer es kann, dann spräche CC eher dagegen.

[Stevie]

Zitat von OlafSt:

Da bist du froh, wenn du sauber gearbeitet und ein paar Kommentare hinterlassen hast.

Da stimme ich zu, persönlich versuche ich es mit Kommentaren so zu halten, dass ich nur dann welche schreibe, wenn der code nicht selbsterklärend ist (man wundert sich manchmal, wie schön das mit guter Architektur und Benennung zu lösen ist) und dann auch nicht, was der Code macht (das sieht man schließlich), sondern warum bzw mit welcher Intention.

Zitat von himitsu:

Wenn keiner den Code versteht, sondern nur noch du (etwas) und die dann auf dich zu kommen müssen, weil kein Anderer es kann, dann spräche CC eher dagegen.

Code der Kategorie versuchte Arbeitsplatzsicherung?

[OlafSt]

Zitat von Stevie:

Code der Kategorie versuchte Arbeitsplatzsicherung?

Nä, so'n Murks mach ich nicht. Hab ich auch nie. In meiner ersten Anstellung als Programmierer wurde mir auf nette, aber bestimmte Art das Teamplay beigebracht. Nett, weil es echt Spaß machte und nicht als Schinderei empfunden wurde. Bestimmt, weil Zuwiderhandlungen unangenehm geahndet wurden

However, ich habe diesen Stil konsequent bis heute durchgehalten und ich hätte keine Bedenken, irgendein Projekt an jemanden weiterzugeben, ohne meine Präsenz neben ihm/ihr. Er/Sie wird wenig Probleme haben, sich da reinzufuchsen.

However.

Zitat:

Wenn keiner den Code versteht, sondern nur noch du (etwas) und die dann auf dich zu kommen müssen, weil kein Anderer es kann, dann spräche CC eher dagegen.

Ich denke eher, es war das Problem, einen Delphi-Entwickler aufzutreiben. Die sind dünn gesät und viel gefragt (weshalb es mir seit Jahren ein Rätsel ist, wieso ich keine Anstellung finden konnte). Die Jungs haben sich tatsächlich von Firma zu Firma gehangelt, um mich aufzuspüren. Ich hatte sogar noch ein Exemplar der Datenformatbeschreibung, die da aus dem angerufenen Gerät kam

Sind bis heute meine besten Kunden - aber auch die anspruchsvollsten.

Egal, BTT.

[Dejan Vu]

Zitat von OlafSt:

Die sind dünn gesät und viel gefragt

Letzeres kann nicht sein, weil es nicht stimmen kann: Wenig Delphi-Entwickler produzieren wenige Projekte mit wenig Nachfrage zur Weiterentwicklung und wenig Nachfrage zur Teamvergrößerung. Ergo sind Delphi-Entwickler selten gefragt.

Bezüglich Kommentaren von Legacy-Code: Natürlich ist es besser, Code zu kommentieren, als ihn nicht zu kommentieren. Aber viel besser ist es eben (imho), den Code selbsterklärend zu schreiben, weil damit ja mehrere Fliegen mit einer Klappe erschlagen werden (Lesbarkeit, Wartbarkeit, Testbarkeit, Skalierbarkeit, Foobarkeit usw.)

Ich partizipiere heute noch von meinen Kommentaren in uralten SQL-Prozeduren, weil ich bis heute noch kein vernünftiges Verfahren anwende, um meine CC-Ansprüche auf SQL-Code anzuwenden.

[himitsu]

Zitat von OlafSt:

Ich denke eher, es war das Problem, einen Delphi-Entwickler aufzutreiben. Die sind dünn gesät und viel gefragt (weshalb es mir seit Jahren ein Rätsel ist, wieso ich keine Anstellung finden konnte). Die Jungs haben sich tatsächlich von Firma zu Firma gehangelt, um mich aufzuspüren.

Komisch, mir kam das mal so vor, als wenn die Firmen garnicht suchen.

Bin mal ganz einfach in eine der wenigen mit Delphi arbeitenden Firmen (laut Telefonbuch gab es nur 3, hier in der Gegend) und hab mehr aus neugier gefragt, wie es eigentlich so aus
sieht, als "doofer" Realschüler und ohne Delphi richtig gelernt zu haben (do it yourself), also ob man da eine Chance in diesem Beruf hätte.
Ohne mich richtig angeguckt zu haben, kam sofort die Antwort "Nö".