AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Tutorials Code Smells

Code Smells

Ein Tutorial von Coffeecoder · begonnen am 5. Mai 2011 · letzter Beitrag vom 11. Jan 2012
Antwort Antwort
Seite 1 von 4  1 23     Letzte » 
Benutzerbild von Coffeecoder
Coffeecoder
Registriert seit: 27. Apr 2011
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
Coffeecoder

Geändert von Coffeecoder ( 6. Mai 2011 um 18:43 Uhr) Grund: Ich wurde gebeten, noch einige Beispiele und Tipps zu den Punkten zu zeigen.
 
MrOuzo
 
#2
  Alt 6. Jul 2011, 12:19
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
  Mit Zitat antworten Zitat
Benutzerbild von Luckie
Luckie

 
Delphi 2006 Professional
 
#3
  Alt 6. Jul 2011, 12:47
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.
Michael
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k
 
#4
  Alt 6. Jul 2011, 14:13
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.
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
  Mit Zitat antworten Zitat
blackfin
 
#5
  Alt 6. Jul 2011, 14:17
Dazu fällt mir folgende Aussage von einem Bekannten ein: "Wieso? Ich weiss doch, dass die Soundsystem-Klasse bei mir Peter heisst"
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k
 
#6
  Alt 6. Jul 2011, 14:19
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.
  Mit Zitat antworten Zitat
brechi
 
#7
  Alt 6. Jul 2011, 22:35
Wenn schon Verbesserung, dann bitte verwende keine With-Statements und rueck den Code richtig ein
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k
 
#8
  Alt 6. Jul 2011, 22:46
Wenn schon Verbesserung, dann bitte verwende keine With-Statements und rueck den Code richtig ein
Was ist an with so böse?
  Mit Zitat antworten Zitat
Benutzerbild von Luckie
Luckie

 
Delphi 2006 Professional
 
#9
  Alt 6. Jul 2011, 23:28
Man sieht nicht mehr auf was sich das with bezieht. Und mitunter kommt der Compiler schon mal durcheinander und dann sucht man sich dumm und dusselig.
Michael
  Mit Zitat antworten Zitat
EWeiss
 
#10
  Alt 6. Jul 2011, 23:47
Außerdem habe ich die Erfahrung gemacht das sich die nachfolgenden Variablen schlecht Debugen lassen.
Da Sie wegen Optimierung unterdrückt werden.

PS:
Und Zeilen sparrt man sich dadurch auch nicht wirklich.

gruss

Geändert von EWeiss ( 6. Jul 2011 um 23:49 Uhr)
  Mit Zitat antworten Zitat
Themen-Optionen Tutorial durchsuchen
Tutorial durchsuchen:

Erweiterte Suche
Ansicht

Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 04:47 Uhr.
Powered by vBulletin® Copyright ©2000 - 2021, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2021 by Daniel R. Wolf