Quellcode Kommentieren

[Dejan Vu]

Ich arbeite als Architekt, Review und Entwickler, letzteres immer weniger.

Es ist nicht mehr Arbeit, wenn man die Methoden auf "3-Zeiler" herunterbricht. Im Gegenteil: Eine Umsetzung ist so wirklich viel viel schneller, weil sie meistens auf Anhieb läuft (bis auf die üblichen Schusseligkeitsfehler). Natürlich: Ich mach das seit Ewigkeiten (vor 30 Jahren jieß0 das Top-Down und 'stepwise refinement')und ich denke gar nicht mehr darüber nach, aber jedesmal, und wirklich jedes Mal, 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.

Mein Tipp an Alle: Fangt mit Clean Code an. Nicht bis zum bitteren Ende, aber so, das man keine Kommentare benötigt, die den Code erklären. Der Code muss sich selbst erklären. Im Idealfall muss das ein englischer Satz (oder maximal 3-5) sein. 'If the customer is valid, then charge fees' ist wirklich 1:1 in Delphi abbildbar (das 'the' kann man weglassen). Schade, das es Linq für Delphi nicht gibt, da geht das noch besser.

Ach, und natürlich benötigt man richtiges Werkzeug. Ich bin auf C# umgestiegen und arbeite mit Resharper, da kann man sehr viel Refactoring ratzfatz schnell durchziehen. Codeschnipsel markieren => Methode extrahieren => Parameter benennen => fertig. Geht so -glaube ich- nicht in Delphi, oder?

[Stevie]

Zitat von Dejan Vu:

Schade, das es Linq für Delphi nicht gibt, da geht das noch besser.

Ach, und natürlich benötigt man richtiges Werkzeug. Ich bin auf C# umgestiegen und arbeite mit Resharper, da kann man sehr viel Refactoring ratzfatz schnell durchziehen. Codeschnipsel markieren => Methode extrahieren => Parameter benennen => fertig. Geht so -glaube ich- nicht in Delphi, oder?

Du hast gerade den Hauptgrund genannt, warum sich diese Cleancode Mentalität in der Delphi Community noch nicht so stark verbreitet hat, wie in anderen Sprachen. Unsere Tools dafür sind teilweise einfach Grütze.

[Sherlock]

Zitat von Stevie:

Zitat von Dejan Vu:

Schade, das es Linq für Delphi nicht gibt, da geht das noch besser.

Ach, und natürlich benötigt man richtiges Werkzeug. Ich bin auf C# umgestiegen und arbeite mit Resharper, da kann man sehr viel Refactoring ratzfatz schnell durchziehen. Codeschnipsel markieren => Methode extrahieren => Parameter benennen => fertig. Geht so -glaube ich- nicht in Delphi, oder?

Du hast gerade den Hauptgrund genannt, warum sich diese Cleancode Mentalität in der Delphi Community noch nicht so stark verbreitet hat, wie in anderen Sprachen. Unsere Tools dafür sind einfach Grütze.

Amen!

Sherlock

[Dejan Vu]

Zitat von Stevie:

Du hast gerade den Hauptgrund genannt, warum sich diese Cleancode Mentalität in der Delphi Community noch nicht so stark verbreitet hat, wie in anderen Sprachen. Unsere Tools dafür sind einfach Grütze.

Na ja. 20 Jahre Pascal mit top-down gingen auch ohne refactoring Tools.

Am Code herumkneten, bis er noch besser wird (speziell Bezeichner umbenennen)... stimmt, Codepflege und die Pfadfindermentalität: Geht ohne Tools wirklich nicht/bzw. schlecht.

Aber stepwise refinement, Probleme in kleine Probleme zu unterteilen, am Anfang abstrakt und erst zum schluß konkret zu werden, also lesbaren Code zu schreiben: Das mache ich schon immer so. Und vor ein paar Jahren hab ich dann gelesen, das das wohl en vogue ist.

[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.