Erste Schritte Frage zum Programmierstil

[FortunaTactics]

Guten Tag zusammen,

ich hätte eine Frage zum Programmierstil.
Da ich hier neu bin stell ich mich mal kurz vor.
Mein Name ist Mike, ich bin 25 Jahre alt und ich lerne seit einigen Wochen Java über ein meiner Meinung nach sehr gutes Online Tutorial, welches einzelne Kapitel hat, wo nach jedem Kapitel Tests,Quiz und Programmieraufgaben sind. Bisher kam ich auch mit allen Aufgaben gut zurecht und habe alle Kapitel verstanden und auch schon eigene kleinere Sachen geschrieben.

Bevor ich mir jetzt etwas falsches angewöhne wollte ich euch fragen ob das folgende guter oder schlechter Programmierstil ist oder ob es völlig egal ist.

Bei einigen verschachtelten Arithmetischen Operationen die aufgrund der Präzedens durch eine vielzahl an Klammern getrennt sind, habe ich mir überlegt mehr Variablen zu deklarieren als nötig.
Einfach um den Code für mich übersichtlicher zu machen und quasi aus einer riesigen Mathematischen Aufgabe mehrere kleine zu machen.
Ähnlich habe ich es mir bei verschachtelten If, else Anweisungen überlegt. Dort könnte ich z.b. den Truezweig in eine Stringvariable speichern und später bei anderen Anweisungen einfach durch den String ausgeben lassen.

Ist das so in Ordnung oder ist es schlechter Programmierstil?
Meistens unterscheidet sich auch mein Code von der Lösung der Programmieraufgaben, obwohl beides zum selben gewünschten Ergebnis führt.

Vielen Dank schonmal für eure Antworten und Kritik ist gerne gewünscht, nur so lernt man =)

 

[Basti90]

Hallo zusammen,

Es ist schwer zu beurteilen ob dein stil schlecht oder gut ist wenn du nur so beschreibst was du tust was sind zum beispiel mehr variablen als nötig?
Vll einfach ein paar codebeispiele bringen...

Einfach um den Code für mich übersichtlicher zu machen

klingt im ersten moment nicht verkehrt übersichtilcher Code erleichtert vieles

ein paar tipps die ich im Studium gelernt habe
- Sprechende Variablennamen
- saubere Textformatierung (einrücken absätze etc.)
- wenn man einen code Kopieren kann innerhalb der klasse(n) dann sollte man ihn in ne methode auslagern

gibt noch viel mehr an tipps frag google :shock: bzw die community weiß bestimmt noch mehr :toll:

P.S. es gibt in den aller meisten Fällen mehr als nur eine Richtige lösung nur weil deine anders ist heißt es nicht das sie schlecht ist

 

[Natac]

Poste doch einfach mal direkt deinen Code. Dann kann man am ehesten sagen, wie man das empfindet.

Denn eins muss dir bei "gut" und "schlecht" im Zusammenhang mit "Programmierstil" klar sein: Es ist und bleibt ein Gefühl. Zwar gibt es einige Kriterien, aber ob ein konkreter Code wirklich "gut" ist, kommt sehr auf den Zusammenhang und den persönlichen Stil des Programmieres an. Ich würde Code als "gut" bezeichnen, der Probleme möglichst elegant und übersichtlich löst.

Prinzipiell solltes du selbst und auch andere deinen Code verstehen. Und das über einen möglichst langen Zeitraum. Alles andere ist "schlecht".

 

[FortunaTactics]

Hallo. Danke für die schnelle Antwort.
Hier ein Beispiel:

[Java]import java.util.*;
import java.lang.*;
public class Aufgabe4
{
public static void main(String[] args)
{
Scanner scan = new Scanner(System.in);
Scanner scan2 = new Scanner(System.in);
Scanner scan3 = new Scanner(System.in);
Scanner scan4 = new Scanner(System.in);

int rvReifen, lvReifen, rhReifen, lhReifen;

System.out.println("Reifendruck: rechter Vorderreifen");
rvReifen = scan.nextInt();
if (rvReifen >=35 && rvReifen <= 45)
System.out.println();
else
System.out.println("Der Reifendruck ist außerhalb des erlaubten Bereichs") ;
System.out.println("Reifendruck: linker Vorderreifen");
lvReifen = scan2.nextInt();

if (lvReifen >=35 && lvReifen <= 45)
System.out.println();
else
System.out.println("Der Reifendruck ist außerhalb des erlaubten Bereichs");

System.out.println("Reifendruck: rechter Hinterreifen");
rhReifen = scan3.nextInt();
if (rhReifen >=35 && rhReifen <= 45)
System.out.println();
else
System.out.println("Der Reifendruck ist außerhalb des erlaubten Bereichs\n");

System.out.println("Reifendruck: linker Hinterreifen");
lhReifen = scan4.nextInt();

if (lhReifen >=35 && lhReifen <= 45)
System.out.println();
else
System.out.println("Der Reifendruck ist außerhalb des erlaubten Bereichs\n");


if (rvReifen == lvReifen && rhReifen == lhReifen)
System.out.println("Reifendruck ist OK");
else
System.out.println("Reifendruck ist nicht in Ordnung");
}
}
[/Java]

Hier gehts um ein Programm das den Reifendruck aller 4 Reifen einzeln abfragt und bisher beide vorder- und hinterreifen vergleicht ob beide den gleichen Wert haben.
Jetzt soll ich das Programm erweitern und zwar so, dasss sowohl beide vorder- als auch beide hinterreifen eine abweichung von jeweils 3 psi haben können ohne das es false ist.
Ich weiß wie ich das umsetzen kann, allerdings müsste ich ja dafür noch if,else anweisungen hinzufügen. Ich fänd es jetzt von meiner aus einfacher, wenn ich als zwischenschritt einfach eine Stringvariable einfüge (ReifenDruckistOk), diese Variable bau ich einfach am Ende in eine If Anweisung ein, anstatt mehrere davon zu verknüpfen.
Ich hoffe ich habe mich verständlich ausgedrückt

Das ist jetzt ein Beispiel. Ähnlich verfahre ich mit int oder double Variable bei verschachtelten Mathematische Operationen.

Bsp.

a = 2+3*5-6
b = 6*8-5+4

summe = a + b - 50 (KONSTANTE)

Meine Idee:

a1 = 3*5
a2 = (a1 - 6) + 2
a = a2

b1 = 6*8
b2 = (b1 - 5) + 4
b = b2


ergebnis1 = a+b
summe = ergebnis1 + KONSTANTE


Ist jetzt etwas übertrieben aber so in etwa mein ich das bei Großen Mathematischen Aufgaben.

 

[Joose]

Also es macht keinen Sinn 4x einen Scanner zu erstellen. Es reicht wenn du diesen 1x erstellst und für alle 4 Sachen die du einlesen willst verwendest!
Es ist zwar valider Code aber bei if/else sind auch bei einzeiligen Statements Klammern immer Vorteilhaft
Und zum Schluss: Du fragst 4x einen Int Wert von der Konsole ab, du überprüfst 4x diesen Wert ob er kleiner gleich bzw. größer gleich zweier Grenzwerte ist, je nach Ergebnis gibst du entweder nichts aus oder eine Warnung -> das ganze lässt sich über eine Methode vereinfachen

    import java.util.*;
    import java.lang.*;
    public class Aufgabe4
    {
        private static final int REIFENDRUCK_MIN = 35;

        private static final int REIFENDRUCK_MAX = 45;

        private static final String FEHLER_REIFENDRUCK = "Der Reifendruck ist außerhalb des erlaubten Bereichs";

        public static void main(String[] args)
        {
            Scanner scan = new Scanner(System.in);           
            int rvReifen, lvReifen, rhReifen, lhReifen;
           
            rvReifen = methode1("rechter Vorderreifen");
            lvReifen = methode1("linker Vorderreifen");
            rhReifen = methode1("rechter Hinterreifen");
            lhReifen = methode1("linker Hinterrreifen");
                   
            if (rvReifen == lvReifen && rhReifen == lhReifen) {
                System.out.println("Reifendruck ist OK");
            } else {
                System.out.println("Reifendruck ist nicht in Ordnung");
            }
        }

        public static int methode1(String reifen){
            System.out.println("Reifendruck: " + reifen);
            int reifendruck = scan.nextInt();
            if(reifendruck >= REIFENDRUCK_MIN && reifendruck <= REIFENDRUCK_MAX) {
                return reifendruck;
            }
            System.out.println(FEHLER_REIFENDRUCK);
            return -1;
        }
    }

Mein Code ist vl nicht viel kürzer als deiner, aber der Vorteil besteht nun darin, dass du die Grenzwerte an nur einer Stelle ändern musst um einen anderen Druck zu erlauben

Jetzt soll ich das Programm erweitern und zwar so, dasss sowohl beide vorder- als auch beide hinterreifen eine abweichung von jeweils 3 psi haben können ohne das es false ist.

Meinst du das der Unterschied zwischen den beiden Hinterreifen bzw. den beiden Vorderreifen max 3psi betragen darf?

Bsp.

a = 2+3*5-6
b = 6*8-5+4

summe = a + b - 50 (KONSTANTE)

Meine Idee:

a1 = 3*5
a2 = (a1 - 6) + 2
a = a2

b1 = 6*8
b2 = (b1 - 5) + 4
b = b2


ergebnis1 = a+b
summe = ergebnis1 + KONSTANTE

Naja um eine komplexe Rechnung zu kontrollieren kann man sie natürlich aufteilen auf mehrere Zeilen, aber wenn man weiß das sie passt sollte man so gut es geht diese wieder zusammenfassen! Bei mathematischen Grundrechnungsarten sollte es ein Einzeiler bleiben (mit der Ausnahme das die Rechnung einfach aus sehr vielen Termen besteht).

 

[FortunaTactics]

Also es macht keinen Sinn 4x einen Scanner zu erstellen. Es reicht wenn du diesen 1x erstellst und für alle 4 Sachen die du einlesen willst verwendest!
Es ist zwar valider Code aber bei if/else sind auch bei einzeiligen Statements Klammern immer Vorteilhaft
Und zum Schluss: Du fragst 4x einen Int Wert von der Konsole ab, du überprüfst 4x diesen Wert ob er kleiner gleich bzw. größer gleich zweier Grenzwerte ist, je nach Ergebnis gibst du entweder nichts aus oder eine Warnung -> das ganze lässt sich über eine Methode vereinfachen

    import java.util.*;
    import java.lang.*;
    public class Aufgabe4
    {
        private static final int REIFENDRUCK_MIN = 35;

        private static final int REIFENDRUCK_MAX = 45;

        private static final String FEHLER_REIFENDRUCK = "Der Reifendruck ist außerhalb des erlaubten Bereichs";

        public static void main(String[] args)
        {
            Scanner scan = new Scanner(System.in);           
            int rvReifen, lvReifen, rhReifen, lhReifen;
           
            rvReifen = methode1("rechter Vorderreifen");
            lvReifen = methode1("linker Vorderreifen");
            rhReifen = methode1("rechter Hinterreifen");
            lhReifen = methode1("linker Hinterrreifen");
                   
            if (rvReifen == lvReifen && rhReifen == lhReifen) {
                System.out.println("Reifendruck ist OK");
            } else {
                System.out.println("Reifendruck ist nicht in Ordnung");
            }
        }

        public static int methode1(String reifen){
            System.out.println("Reifendruck: " + reifen);
            int reifendruck = scan.nextInt();
            if(reifendruck >= REIFENDRUCK_MIN && reifendruck <= REIFENDRUCK_MAX) {
                return reifendruck;
            }
            System.out.println(FEHLER_REIFENDRUCK);
            return -1;
        }
    }

Mein Code ist vl nicht viel kürzer als deiner, aber der Vorteil besteht nun darin, dass du die Grenzwerte an nur einer Stelle ändern musst um einen anderen Druck zu erlauben



Meinst du das der Unterschied zwischen den beiden Hinterreifen bzw. den beiden Vorderreifen max 3psi betragen darf?



Naja um eine komplexe Rechnung zu kontrollieren kann man sie natürlich aufteilen auf mehrere Zeilen, aber wenn man weiß das sie passt sollte man so gut es geht diese wieder zusammenfassen! Bei mathematischen Grundrechnungsarten sollte es ein Einzeiler bleiben (mit der Ausnahme das die Rechnung einfach aus sehr vielen Termen besteht).

Hallo. Danke für die Antwort.
Ich finde deinen Code sehr übersichtlich und einfacher als meinen.
Allerdings bin ich noch nicht so weit was die Methode angeht. Werde es mir aber mal genauer anschauen. Vielen Dank.
Genau Die Vorderreifen müssen zwischen 35 und 45 psi haben. Dürfen aber parallel um 3 psi abweichen.
z.B. lvr 38 rvr 41. Mit den Hinterreifen dasselbe.

Zu den Matheaufgaben. Klar bei so einfachen Sachen brauch man es nicht splitten.
Hatte es z.b. bei Grad und Bogenmaß. Da hab ich mehr Variablen deklariert als ich laut Aufgabenstellung gebraucht hätte. Das Ergbenis war dasselbe, nur für mich im Code einfacher umzusetzen und auch zu lesen.
Zu Scanner: Ich hatte es mal so gemacht: Scanner scan = new Scanner(System.in);
Hatte dann aber bei der 2., 3. und 4. Eingabe eine Fehlermeldung vom Compiler. Habs dann geändert in scan2, scan3 usw. und dann funktionierte es. Deshalb mehrer Scanner.
Werde es mir aber nochmal genauer anschauen. Meist sind es ja kleinigkeiten die dann ein Compiler Fehler verursachen.

Worum es mir geht ist, dass ich mir jetzt als totaler Anfänger nichts falsches angewöhne.
Ich denke, dass je mehr ich lerne desto besser und übersichtlicher wird dann auch Code, aber grundsätzlich ist es nicht falsch oder schlecht wenn man mehr Variablen, Strings etc. deklariert um es für sich selbst übersichtlicher zu gestalten?

Noch eine Frage zur IDE: Ich arbeite mit BlueJ. Kann man diese auch benutzen wenn man später professionell damit arbeiten möchte oder sollte es dann eher sowas wie Netbeans oder Eclipse sein?
Mir persönlich gefällt BlueJ sehr gut.

Danke nochmal.

 

[Joose]

Hallo. Danke für die Antwort.
Ich finde deinen Code sehr übersichtlich und einfacher als meinen.
Allerdings bin ich noch nicht so weit was die Methode angeht. Werde es mir aber mal genauer anschauen. Vielen Dank.
Genau Die Vorderreifen müssen zwischen 35 und 45 psi haben. Dürfen aber parallel um 3 psi abweichen.
z.B. lvr 38 rvr 41. Mit den Hinterreifen dasselbe.

Aso ok, na klar einfach hier oder dort die Überprüfung einfügen und fertig.
Je nach Anforderung könnte man natürlich eine Methode schreiben, welche den Reifendruck der Vorderreifen einliest und dann auch gleich die Überprüfung durchführt.
Aber gut wenn du Methoden noch nicht kannst dann natürlich nichts überstürzen.

Zu den Matheaufgaben. Klar bei so einfachen Sachen brauch man es nicht splitten.
Hatte es z.b. bei Grad und Bogenmaß. Da hab ich mehr Variablen deklariert als ich laut Aufgabenstellung gebraucht hätte. Das Ergbenis war dasselbe, nur für mich im Code einfacher umzusetzen und auch zu lesen.

Wie gesagt Zwischenergebnisse sind beim Entwickeln natürlich praktisch. Aber generell schaut man das Methode so kurz wie möglich sind.

Zu Scanner: Ich hatte es mal so gemacht: Scanner scan = new Scanner(System.in);
Hatte dann aber bei der 2., 3. und 4. Eingabe eine Fehlermeldung vom Compiler. Habs dann geändert in scan2, scan3 usw. und dann funktionierte es. Deshalb mehrer Scanner.
Werde es mir aber nochmal genauer anschauen. Meist sind es ja kleinigkeiten die dann ein Compiler Fehler verursachen.[/QUOTE]

Na klar, bei sowas kannst du hier natürlich auch fragen wo denn dein Fehler liegt (wenn Google nicht hilft).

Noch eine Frage zur IDE: Ich arbeite mit BlueJ. Kann man diese auch benutzen wenn man später professionell damit arbeiten möchte oder sollte es dann eher sowas wie Netbeans oder Eclipse sein?
Mir persönlich gefällt BlueJ sehr gut.

Naja BlueJ ist für einen Anfänger natürlich Klasse. Aber auf professioneller Ebene ungeeignet
Generell gibt es auch viele die meinen BlueJ ist schlecht um Java zu lernen da es einem Anfänger zuviel Arbeit abnimmt und dieser dann später viele Fehler nicht erkennen und lösen kann. (weil BlueJ eben einen die Arbeit abnimmt)

 

[FortunaTactics]

Vielen Dank.
Okay also wäre es auf langfristige Sicht sinnvoller direkt mit Eclipse anzufangen?
Gut da ich ja noch relativ am Anfang bin dürfte das Umgewöhnen nicht allzu groß sein nehme ich an =)

Ich bin wirklich für jeden dankbar.
Was mich so ein bisschen abgeschreckt hat, war das es ganze Tutorials gibt für IDE´s wie Eclipse.
BlueJ ist selbsterklärend und sehr einfach. Aber ich möchte ja mal Professionell damit arbeiten und auch Software für eine Firma entwickeln. Projektideen sind schon vorhanden. Deshalb gewöhn ich mich jetzt schnell an Eclipse. Danke nochmal an dieser Stelle.

Ich glaube das war es vorerst. Ihr habt mir sehr geholfen.
Bestimmt stell ich noch öfter Fragen :lol:

 

[Ruzmanz]

Generell gibt es auch viele die meinen BlueJ ist schlecht um Java zu lernen da es einem Anfänger zuviel Arbeit abnimmt und dieser dann später viele Fehler nicht erkennen und lösen kann.

Welche Arbeit nimmt BlueJ ab? Syntaxhervorhebung? ...

Den Code sollte man eher nicht so formatieren. Man könnte meinen, dass dein else-Zweig im If-Block drinnen ist. Bei deinen Beispiel sieht man das relativ schnell, aber was wird aus?:

->
        if (rvReifen == lvReifen && rhReifen == lhReifen)
            System.out.println("Reifendruck ist OK");
            else if(rvReifen != lvReifen)
                System.out.println("Reifendruck ist nicht in Ordnung");

 

[FortunaTactics]

Welche Arbeit nimmt BlueJ ab? Syntaxhervorhebung? ...

Den Code sollte man eher nicht so formatieren. Man könnte meinen, dass dein else-Zweig im If-Block drinnen ist. Bei deinen Beispiel sieht man das relativ schnell, aber was wird aus?:

->
        if (rvReifen == lvReifen && rhReifen == lhReifen)
            System.out.println("Reifendruck ist OK");
            else if(rvReifen != lvReifen)
                System.out.println("Reifendruck ist nicht in Ordnung");

Ich glaub ich steh gerade etwas auf dem Schlauch
Meinst du das es besser wäre jede If, else anweisung mit einer Geschweiften Klammer zu trennen und nochmal seperat einzurücken? Funktioniert das auch bei verschachtelten If, else anweisungen?

z.b.
[Java] { if (x == y)
System.out.println("Okay")
} { else
if (x < y) }
........ usw.[/code]

Geht ja jetzt hauptsächlich um die Übersichtlichkeit und Einrücken bzw. Trennung von if und else, oder hab ich das jetzt falsch verstanden?

Vielen Dank.

 

[Natac]

Ich glaub ich steh gerade etwas auf dem Schlauch
Meinst du das es besser wäre jede If, else anweisung mit einer Geschweiften Klammer zu trennen und nochmal seperat einzurücken? Funktioniert das auch bei verschachtelten If, else anweisungen?

z.b.
[Java] { if (x == y)
System.out.println("Okay")
} { else
if (x < y) }
........ usw.[/code]

Geht ja jetzt hauptsächlich um die Übersichtlichkeit und Einrücken bzw. Trennung von if und else, oder hab ich das jetzt falsch verstanden?

Vielen Dank.

Es geht darum, dass dieses If-else eigentlich so aussehen sollte:

if(x == y){
  System.out.println("Okay")
}
else if (x < y){
 //...
}[/Java]Und ich empfehle dir, um if und else IMMER geschweifte Klammern zu schreiben. Auch wenn es nur eine Anweisung ist.

 

[FortunaTactics]

Es geht darum, dass dieses If-else eigentlich so aussehen sollte:

if(x == y){
  System.out.println("Okay")
}
else if (x < y){
 //...
}[/Java]Und ich empfehle dir, um if und else IMMER geschweifte Klammern zu schreiben. Auch wenn es nur eine Anweisung ist.[/QUOTE]


Guten Tag.
Dankesehr. Oh man ich hoffe ich werde nicht nervig ;) Aber ich bin sehr neugierig.

Gut, also zum Verständnis in meinen Worten:

Bei jeder if,else anweisung geschweifte Klammern nutzen auch wenn nur eine Anweisung statt ein Anweisungsblock benötigt wird.
Erst if (Bedingnung) {
          Anweisung 
       }
       else ...

bei       else if (Bedingung) {     // dasselbe nochmal und else if   immer in eine Zeile


Mein Fazit vom Thread:  

Nach Möglichkeit mit Methoden arbeiten. (Lern ich noch)
Zeilen sparen aber dennoch übersichtlich halten und einrücken.
Zur besseren Lesbarkeit geschweifte Klammern auch bei nur einer Anweisung nutzen.
Aussagekräftige Variablen benutzen.
Referenzvariable von Scanner kann beliebig oft benutzt werden.

Korrigiert mich wenn ich falsch liege.

Sehr nette Community und sehr hilfreiche Antworten.
Danke nochmal.