Funktion hier sinnvoll ?

[sowieso]

Hi !

Ich hab mal eine allgemeine Frage, wann man Funktionen einsetzt.

Sagen wir, wir haben eine HashMap <String,Integer> die schon mit mehreren Map.Entrys gefüllt ist. In einer Funktion start() werden je nach Situation (hängt vom Zustand von Variablen einer anderen instantiierten Klasse ab) bestimmte Map.Entrys aus der HashMap entfernt.

Folgender Code dient nur als Skizze und ist nicht korrekt:

public void start()
{
    HashMap <String,Integer> map = reader.data();
    
    for(int i=0; i<panel.size(); i++)
    {  
        if (panel.checked(i))
        {
            HashMap.remove(panel.getKey(i));
        }
    }   
}

Wäre jetzt folgender Code besser ? -->

public void start()
{
    HashMap <String,Integer> map = reader.data();
    
    map = adjustMap(map);    
}

private HashMap<String,Integer> adjustMap(HashMap<String,Integer> map)
{
    for(int i=0; i<panel.size(); i++)
    {  
        if (panel.checked(i))
        {
            map.remove(panel.getKey(i));
        }
    }
    return map;
}

Also durch verwendung einer Funktion wird der Code in der Funktion start() ja übersichtlicher. Andererseits erspart die Funktion ja keinen Code. Und kann auch nur einmal für start() verwendet werden...

Würdet ihr sagen, dass letzteres oder ersteres besser ist ?

 

[sliwalker]

Hoi,

prinzipiell würde ich dazu sagen, dass man Aufgaben in Funktionen bzw. Methoden auslagert, wenn

a) es dazu beiträgt den Code leserlicher zu machen
b) man dadurch logisch getrennte Bereiche auch "physikalisch" trennt
c) man Teilbereiche einer "großen" Aufgabe noch an anderer Stelle wiederverwenden/aufrufen möchte.


Bsp: Eine Passworteingabe muss überprüft werden auf:
- formale Korrektheit (mind. eine Ziffer)
- andere Sicherheitskriterien (muss sich von den letzten drei Passwörtern unterscheiden)

Man kann das jetzt alles in eine Methode haun:

public boolean checkPassword(String strPassword)
{
    if (strPassword hat eine Ziffer)
    {
         if (strPassword unterscheidet sich von den letzten drei PW)
         {
              return (true);
          }
    }
    return (false);
}

Was aber, wenn an einer anderen Stelle nochmal überprüft werden soll, ob ein Passwort formal korrekt ist?

...es muss halt Sinn machen...

Bei Deinem Problem musst Du abschätzen, ob adjustMap und start() IMMEr zusammengehören. Wenn ja, nicht auslagern.

greetz
SLi

 

[Bit2_Gosu]

Ok, vielen Dank für deine ausführliche Antowort !

Dann werde ich hier keine Funktion benutzen.

 

[Guest]

Hallo

Als Ergaenzung zum Vorgaenger:

1. Immer eine Methode erstellen, wenn der Code "zu lang" wird. Sprich spaetestens wenn man scrollen muesste!

2. Gut strukturieter Code hilft sinnlose Kommentare zu vermeiden. Sprich immer wenn du meinst einen Kommentar in deinen Code schreiben zu muessen; Ueberleg erstmal, ob du nicht durch eine bessere Strukturierung und bessere Benennung den Kommentar sparen kannst.

3. Den "Schleifenkoerper" kann man fast immer in eine Methode auslagern. Dadurch muss der Leser nicht mehr den Code verstehen, sondern kann sich direkt auf die fachlichen Aufgaben konzenrieren.

Auf dein Beispiel angewendet:

public void start() 
{ 
    HashMap <String,Integer> map = reader.data(); 
    
    for(int i=0; i<panel.size(); i++) 
    {  
        removeCheckedPanel(map,panel.getKey(i))
    }    
}

private void removeCheckedPanel(Map map,String key) { // dir faellt sicher ein besserer Name ein
        if (panel.checked(i)) 
        { 
            map.remove(key); 
        } 
}

Vielleicht noch besser:

public void start() 
{ 
    HashMap <String,Integer> map = reader.data(); 
    checkPanel(panel,map);  
}

private void checkPanel(Panel panel,Map map) {
    for(int i=0; i<panel.size(); i++) 
    {  
        removeCheckedPanel(map,panel.getKey(i))
    }  
}

private void removeCheckedPanel(Map map,String key) {
        if (panel.checked(i)) 
        { 
            map.remove(key); 
        } 
}

Anmerkung:
- Fuer Syntaxfehler uebernehme ich keine Haftung ...
Vorteile:
- Derjenige der sich die Methode start anschaut sieht relativ schnell was fachlich passeiren soll.
- wenn er taetsaechlich mal nachschauen will sieht er in checkPanel sofort was fachlich passiert. Schleife und fachlich removeCheckedPanel. Ohne den Code weiter anschauen zu muessen...

Die Implementierung dieser Struktur dauert uebrigens fuer geuebte Entwickler etwa eine Minute laenger. Sprich auch kein wesentlicher Zeitverlust. Aber ein enomer Qualitaetsgewinn.

 

[Gast]

Es sind noch mindestens zwei weitere Punkte erwähnenswert.
Wenn ein Teil mehrfach Programmiert werden müßte. Ein Block oder eine Reihe von Befehlen kommt gleich in mehreren verschiedenen Methoden vor, bzw. mehrfach in einer Funktion, so kann man diesen redundanten Teil in eine Funktion auslagern und muß sich dann nur um diese eine Codestelle kümmern. Also wenn man diese Codestelle später ändern möchte.

Das zweite wäre die Testbarkeit. Beim Testen sollte die zu testende Klasse unverändert bleiben. Sprich es sollten keine extra Debuggingmessages etc. eingesetzt werden usw. Hat man nun feiner granulierte Methoden, kann man auch viel feiner testen. Eine Codestelle, die früher in einer Riesigen Funktion versteckt ist, kann so leicht zugänglich und gut testbar werden.