Unbenutztes Element: Unterschied zwischen den Versionen

Aus Programmieren-Wiki
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 2: Zeile 2:
|baustelle=Ja
|baustelle=Ja
|blatt=1
|blatt=1
|beschreibung=Elemente wie Klassen, Methoden und Zeilen, die nicht im Projekt benutzt werden sollten in dem finalen Produkt entfernt werden, da sie keinen weiteren Nutzen haben und lediglich den Lesefluss stören.
Auch Elemente die einen vermeindlichen zukünftigen Nutzen haben könnten, wie zum Beispiel getter und setter Methoden für Attribute die zurzeit nicht genutzt werden sollten nicht in der finalen Version vorhanden sein.
Sollte eine Person diese Attribute in einer zukünftigen Version benutzen wollen, kann das nachträglich zugefügt werden.
Desweiteren kann es mit zu vielen unbenutzten Elementen zu einer unnötig großen Programmgröße und einem erschwerten Debugging führen. In den Projekten die wir in dieser Übungsvorstellung schreiben macht dies zwar keinen großen Unterschied, es sollte sich aber trotzdem nicht angewöhnt werden, unbenutzte Elemente zu behalten.
|schweregrad=leicht
|schweregrad=leicht
|negativ=<syntaxhighlight lang="Java">
public static void main(String[] args) {
    Vector vector = new Vector(1, 2, 3);
    System.out.println(vector.getLength());
}
...
public class Vector {
    private final int x;
    private final int y;
    private final int z;
   
    public Vector(int x, int y, int z) {
        this.x = x;
        this.y = y;
        this.z = z;
    }
    public int getX() {
        return this.x;
    }
    public int getLength() {
        return Math.sqrt(x*x + y*y + z*z);
    }
}
</syntaxhighlight>
Auch wenn es in Zukunft vielleicht gut wäre, die x-Koordinate des Vektors zu erhalten, ist es in unserem Program gerade nicht benutzt und kann und soll demnach entfernt werden.
|positiv=<syntaxhighlight lang="Java">
public static void main(String[] args) {
    Vector vector = new Vector(1, 2, 3);
    System.out.println(vector.getLength());
}
...
public class Vector {
    private final int x;
    private final int y;
    private final int z;
    public Vector(int x, int y, int z) {
        this.x = x;
        this.y = y;
        this.z = z;
    }
    public int getLength() {
        return Math.sqrt(x*x + y*y + z*z);
    }
}
</syntaxhighlight>
|kategorie=Programmierstil
|kategorie=Programmierstil
|weiterlesen=Nein
|weiterlesen=Nein
}}
}}

Version vom 3. Mai 2024, 16:30 Uhr

🚧 Diese Seite befindet sich in Bearbeitung 🚧
🤓 Diese Seite ist eine Bewertungsrichtlinie, die ab Blatt 1 annotiert und ab Blatt 2 abgezogen wird. 🤓

Beschreibung

Elemente wie Klassen, Methoden und Zeilen, die nicht im Projekt benutzt werden sollten in dem finalen Produkt entfernt werden, da sie keinen weiteren Nutzen haben und lediglich den Lesefluss stören.

Auch Elemente die einen vermeindlichen zukünftigen Nutzen haben könnten, wie zum Beispiel getter und setter Methoden für Attribute die zurzeit nicht genutzt werden sollten nicht in der finalen Version vorhanden sein.

Sollte eine Person diese Attribute in einer zukünftigen Version benutzen wollen, kann das nachträglich zugefügt werden.

Desweiteren kann es mit zu vielen unbenutzten Elementen zu einer unnötig großen Programmgröße und einem erschwerten Debugging führen. In den Projekten die wir in dieser Übungsvorstellung schreiben macht dies zwar keinen großen Unterschied, es sollte sich aber trotzdem nicht angewöhnt werden, unbenutzte Elemente zu behalten.


Negativbeispiel

public static void main(String[] args) {
    Vector vector = new Vector(1, 2, 3);
    System.out.println(vector.getLength());
}

...

public class Vector {
    private final int x;
    private final int y;
    private final int z;
    
    public Vector(int x, int y, int z) {
        this.x = x;
        this.y = y;
        this.z = z;
    }

    public int getX() {
        return this.x;
    }

    public int getLength() {
        return Math.sqrt(x*x + y*y + z*z);
    }
}

Auch wenn es in Zukunft vielleicht gut wäre, die x-Koordinate des Vektors zu erhalten, ist es in unserem Program gerade nicht benutzt und kann und soll demnach entfernt werden.

Positivbeispiel

public static void main(String[] args) {
    Vector vector = new Vector(1, 2, 3);
    System.out.println(vector.getLength());
}

...

public class Vector {
    private final int x;
    private final int y;
    private final int z;

    public Vector(int x, int y, int z) {
        this.x = x;
        this.y = y;
        this.z = z;
    }

    public int getLength() {
        return Math.sqrt(x*x + y*y + z*z);
    }
}