Code Smells

[Coffeecoder]

Hallo DP-Mitglieder,

Ich habe ein kleinen Kurs über das Thema "Code Smells" für euch vorbereitet.
Das Ziel dieses Kurses ist das Verstehen was "Code Smells" sind. Denn jeder Programmierer hat (unbewusst) solche in seinem Code.

Theorie:

Das Wort "Code Smells" was übersetzt "(schlechter) Geruch" heißt,
stammt von Kent Beck und wurde durch das Buch Refactoring von Martin Fowler verbreitet.

Code Smells ist ein schlecht strukturierter Programmcode.
Der Code ist für den oder einen anderen Programmierer schwer zu verstehen.

Bei Verbesserungen oder Erweiterungen kommen neue Fehler dazu.
"Code Smells" wird erst erkannt bei einer Überarbeitung des Programmcodes.

Welche "Code Smells" existieren?

Es gibt eine Unmenge von schlecht-struktierter Programmcode-Beispiele.
Hier einige Beispiele die sich auf die objektorientierte Programmierung (Java, Delphi, ...) beziehen:

1. Code-Vermehrung: Der identische Code taucht im Programm an mehreren Stellen auf.
2. Langer Code in Methode: Der Programmcode in einer Funktion, Prozedur ist zu lang.
3. Lange Parameterliste: einige übergebene Parameter die unnötig sind.
4. Nichtaussagender Name: Aussagekräftige Name erfüllen das Verständnis des Codes oder Inhalt einer Variable.
5. Toter Code: Ein Programmcode welches nicht mehr gebraucht wird.

Quelle : http://de.wikipedia.org/wiki/Code_smells

Natürlich gibt es noch mehrere Arten und interessante Bücher die das Thema detaillierter
beschreiben wie z.B das Buch : "Clean Code - Refactoring, Patterns, Testen und Techniken für sauberen Code" von Robert C. Martin.

Beispiele/Tipps:

1. "Code-Smell"
   
   Delphi-Quellcode:

   procedure anpassenChart;
   begin
                   with Chart1 do
                   begin
                          Legend.visible := false;
                          View3D := false;
                          Title.Text.Clear;
                          Title.Text.Add('Chart');
                   end;
   
                   with Chart2 do
                   begin
                          Legend.visible := false;
                          View3D := false;
                          Title.Text.Clear;
                          Title.Text.Add('Chart');
                   end;
   
                   with Chart3 do
                   begin
                          Legend.visible := false;
                          View3D := false;
                          Title.Text.Clear;
                          Title.Text.Add('Chart');
                   end;
   end;

   Es ist nicht falsch, der Code funktionniert ja. Aber was ist schlecht daran?
   Ganz einfach: Es sollen jetzt doch Legende visible sein. Was macht man?
   Legend.visible := true setzen und Copy-Paste.
   Das ist anfällig für Fehler, einmal nicht aufgepasst und schon ein Legend.visible := false vergessen zu überschreiben.
   
   So macht man es besser:
   
   Delphi-Quellcode:

   procedure anpassenChart(ch : TChart);
   Begin
                   with ch do
                   begin
                         Legend.visible := false;
                         View3D := false;
                         Title.Text.Clear;
                         Title.Text.Add('Chart');
                   end;
   end;

   Aufruf:
   
   Delphi-Quellcode:

   ...
   var i : integer;
   begin
           for  i := 1 to 3 do anpassenChart('Chart'+IntToStr(i));
   end;

2. und
3. Beide Punkten sind verwandt, denn es geht ja um Methoden (Funktion, Prozedur).
   Hier zeige ich kein Beispiel, aber ein paar Tipps:
   1. Kurze Parameterliste, welche für eine einzige Aufgabe gebraucht werden.
   2. Es sollen nicht mehr als 20 Programmzeilen in einer Methode stehen.
   3. Eine Methode soll nur eine Aufgabe erfüllen. (eine Funktion die den Flächeninhalt eines Kreises berechnet, soll nicht noch den Umfang berechnen, dies sollte in einer separaten Funktion untergebracht werden.)
4. Ich komme sofort zu einem Beispiel:
   
   Schlechter Name:
   
   
   Delphi-Quellcode:

   var
        d : integer;
   begin
          ...
          if d  ... 
   end;

   Was will die Variable d uns sagen? Nicht viel!
   
   Besser:
   
   
   Delphi-Quellcode:

   ...
   var
        TageSeitErstellung : integer;
   
   begin
         ...
         if TageSeitErstellung ....
   
   end;

   Hier sagt die Variable TageSeitErstellung uns der Zweck dieser Variable aus. Man weiss sofort, der Inhalt ist die Anzahl Tage seit der Erstellung von ...
   
   Noch ein typisches Beispiel mit dem Typ boolean:
   
   
   Delphi-Quellcode:

   var
         Daten : boolean;

   Daten sagt wieder nichts aus. Man kann es so verstehen:
   1. DatenGeLoescht
   2. DatenVorhanden
   3. DatenGesendet
   4. DatenVerarbeitet
   5. DatenKorrupt
   6. ...
   
   
5. Toter Code ist :
   1. Ein auskommentierter Code
   2. Ein Codestück welches immer übersprungen wird. Hier ist die if-Anweisung überflüssig:
      
      Delphi-Quellcode:

      var
        N : int;
      
      begin
              N := 0;
              ...
              if N = 3 then
              begin
                   ....
              end;
              ...
      end;

Schlusswort:

Kennt man einige Code-Smells, so kann man diese vermeiden, damit der Programmcode nicht "schlecht riecht".

Ich hoffe ich könnte euch ein bisschen über dieses interessante Thema erzählen.
Bitte um konstruktive Kritik.

Danke bis Bald.

Mfg Coffeecoder

[MrOuzo]

Hallo Coffeecoder,

gefällt mir ganz gut, fällst bei deinem Beispiel dann über die eigenen Regeln.

ich denke

Delphi-Quellcode:

procedure anpassenChart(ch : TChart);
Begin
end;

hier ist ch auch nicht gerade ein aussagekräftiger Parameter, könnte auch ein Char oder so sein

Gruß
MrOuzo

[Luckie]

Außerdem wird hier als Parameter eine Zeichenkette übergeben: anpassenChart('Chart'+IntToStr(i)); laut Deklaration müsste es aber ein Objekt vom Typ TChart sein. Mir ist zwar klar, was du aussagen willst, aber trotzdem sollte es doch ein Beispiel sein, was zumindest compiliert.

[s.h.a.r.k]

Zitat von Luckie:

Außerdem wird hier als Parameter eine Zeichenkette übergeben: anpassenChart('Chart'+IntToStr(i)); laut Deklaration müsste es aber ein Objekt vom Typ TChart sein. Mir ist zwar klar, was du aussagen willst, aber trotzdem sollte es doch ein Beispiel sein, was zumindest compiliert.

Ein einfaches FindComponent würde hier dann wohl schon reichen, sodass es klappt.

Zitat von MrOuzo:

Delphi-Quellcode:

procedure anpassenChart(ch : TChart);
Begin
end;

hier ist ch auch nicht gerade ein aussagekräftiger Parameter, könnte auch ein Char oder so sein

Hier sollte man sich mal die VCL anschauen, die an sehr vielen stellen folgende Konvention nutzt:

Delphi-Quellcode:

procedure anpassenChart(AChart: TChart);
Begin
end;

Wobei das leider nicht immer der Fall ist -- ist mir neulich allein schon mal wieder bei der Format-Funktion aufgefallen.

Ansonsten muss ich sagen, dass das ein interessanter Einstieg sein kann

[blackfin]

Dazu fällt mir folgende Aussage von einem Bekannten ein: "Wieso? Ich weiss doch, dass die Soundsystem-Klasse bei mir Peter heisst"

[s.h.a.r.k]

Zitat von blackfin:

Dazu fällt mir folgende Aussage von einem Bekannten ein: "Wieso? Ich weiss doch, dass die Soundsystem-Klasse bei mir Peter heisst"

Leider sieht man sowas bei viel zu vielen Programmierern. Liegt imho dann aber auch daran, dass diese noch nie im Team programmiert haben.

[Coffeecoder]

Hey,

Ich danke für eure Feedbacks. Es ist mir klar, dass es schon bisschen her ist.

Zitat von MrOuzo:

Hallo Coffeecoder,

gefällt mir ganz gut, fällst bei deinem Beispiel dann über die eigenen Regeln.

ich denke

Delphi-Quellcode:

procedure anpassenChart(ch : TChart);
Begin
end;

hier ist ch auch nicht gerade ein aussagekräftiger Parameter, könnte auch ein Char oder so sein

Gruß
MrOuzo

Das stimmt da falle ich selbst über die "Anti-Code-Smells"-Regeln. Besser soll heissen, wie bereits erwähnt:

Delphi-Quellcode:

procedure anpassenChart(pchart : TChart);
Begin
    ....
end;

Weiter gehts

Zitat von Luckie:

Außerdem wird hier als Parameter eine Zeichenkette übergeben: anpassenChart('Chart'+IntToStr(i)); laut Deklaration müsste es aber ein Objekt vom Typ TChart sein. Mir ist zwar klar, was du aussagen willst, aber trotzdem sollte es doch ein Beispiel sein, was zumindest compiliert.

Da habe ich wieder nicht aufgepasst

Also ich bedanke mich für eure Hinweise und Vorschläge, ich werde das Tutorial wohl einmal überarbeiten müssen und gebe es als PDF auch frei.

Bis dahin, habt bisschen Geduld

[DeddyH]

Zitat von Coffeecoder:

Delphi-Quellcode:

procedure anpassenChart(pchart : TChart);
Begin
    ....
end;

Der Präfix P erweckt aber eher den Eindruck, es handle sich um einen Zeiger auf ein TChart. Wieso nicht einfach Chart, AChart oder meinetwegen TheChart?

[Coffeecoder]

Zitat von DeddyH:

Zitat von Coffeecoder:

Delphi-Quellcode:

procedure anpassenChart(pchart : TChart);
Begin
    ....
end;

Der Präfix P erweckt aber eher den Eindruck, es handle sich um einen Zeiger auf ein TChart. Wieso nicht einfach Chart, AChart oder meinetwegen TheChart?

Hmm ok. Ich habe gerade diesen Beitrag hier in der DP gefunden

[bernau]

Zitat von DeddyH:

Zitat von Coffeecoder:

Delphi-Quellcode:

procedure anpassenChart(pchart : TChart);
Begin
    ....
end;

Der Präfix P erweckt aber eher den Eindruck, es handle sich um einen Zeiger auf ein TChart. Wieso nicht einfach Chart, AChart oder meinetwegen TheChart?

Daran habe ich auch zuerst gedacht. Aber letztendlich ist es ein Zeiger auf ein Objekt vom Type TChart. Sieht trotzdem schrecklich aus