OOP Java Kommentare, Programm besser verstehen

[Speedy85]

Hallo, ich habe hier ein Programm das ich gerne besser verstehen möchte. Nun habe ich mich hingesetzt und es mit hilfe von Google, soweit wie möglich Kommentiert, sollte der schnellste Weg sein ein Programm besser zu verstehen. Ich hoffe das Ihr mir helfen könnt, ich weiß nicht ob ich fehler in den komentaren habe. Vielen Danke im vorraus:

Programm 1

import java.io.*;
import java.text.*;

class Timer
{
  static PrintWriter out = new PrintWriter(System.out, true); 

  static DecimalFormat // statische funktion
    f1 = new DecimalFormat("00"), // objekt mit dem 2 x 0 Format
    f2 = new DecimalFormat("000"); // objekt mit dem 3 x 0 Format

  int min, sek, tsdSek;	// var. deklarieren

  void stelle(int min, int sek, int tsdSek) // Methode mit 3 int variablen
  {
    this.min    = min;	// die obere min gleich der min in der void methode
    this.sek    = sek;  // die obere sek gleich der sek in der void methode
    this.tsdSek = tsdSek; // die obere min gleich der min in der void methode
  }

  void tick()		// methode tick
  {
    if (++tsdSek == 1000)
    {
      tsdSek = 0;
      if (++sek == 60)
      {
        sek = 0;
        min++;
      }
    }
  }

  void zeigeAn()		// Methode zeigeAn
  {
    out.println(
      f1.format(min) + ":" + f1.format(sek) + ":" + f2.format(tsdSek));
  }

  public String toString()// gibt ZeigeAn werte als String aus
  {
    return "Zeit: "
      + f1.format(min) + ":" + f1.format(sek) + ":" + f2.format(tsdSek);
  }
}

Programm 2

class SignalTimer extends Timer // Von der Klasse Timer erben
{
  final static char SIGNAL = 7;    // Statische Funktion Signal dem wert 7 übergeben
  boolean aktiv = false;			// Variable aktiv mit false deklarieren
  int minSig, sekSig, tsdSekSig;	// 3 Variablen dem vartyp int zuweisen
    
  void sigTick() 	// Methode sigTick
  {
    tick();			// Methode tick von der Timer klasse geerbt
    
    if (aktiv) 		// Wenn aktiv ..
    {
      if ((min == minSig) && (sek == sekSig) && (tsdSek == tsdSekSig)) // wenn min==minSig ... gleich ist
      {
        Timer.out.print(SIGNAL);  // In Timer (Signal) ausgeben
        Timer.out.flush(); // ?????
        aktiv = false; // aktiv wird zu false
      }
    }
  }
    
  public String toString() // Methode deklarieren
  {
    return super.toString() // toString von der Timer Klasse erben und ausgeben
      + "  Signalzeit: " 
      + Timer.f1.format(minSig) + ":" 
      + Timer.f1.format(sekSig) + ":" 
      + Timer.f2.format(tsdSekSig) 
      + (aktiv ? " aktiviert" : " nicht aktiviert");
    }        
}

Programm3

class TimerTB
{
  final static int N = 5000;  // 5000 Ticks in einer funktion mit int N übergeben

  public static void main(String[] args) // main methode
  {
    SignalTimer st = new SignalTimer(); // Objekt st deklarieren
    Timer t = new Timer(); // Objekt t deklarieren

    st.aktiv = true; // der klasse st (Signaltimer) den wert für aktiv true überliefern
    st.tsdSekSig = 999; // der klasse st (Signaltimer) den wert 999 für tsdSekSig übergeben
    Timer.out.println(st); // st an die klasse Timer schicken
    Timer.out.println(t); // t an die Klasse Timmer schicken

    for (int i = 1; i <= N; i++)
    {
       st.sigTick();
       t.tick();
    }
    Timer.out.println(st); // das gleiche wie oben nochmal
    Timer.out.println(t); // das gleiche wie oben nochmal
  }
}

 

[eRaaaa]

final static char SIGNAL = 7;    // Statische Funktion Signal dem wert 7 übergeben

das ist keine funktion und auch kein funktionsaufruf, sondenr einfach eine klassenvariable welcher der wert 7 zugewiesne wird.

das gleiche hast du im programm 3 bei N und beim decimalformat.

variablen können auch static sein. es sind nicht automatisch methoden, wnen da static vor steht(ich erwähne das nur, weil es mir so vorkommt, als wenn du das so verstandne hättest)

 

[Speedy85]

Danke eRaaaa, das wusste ich jetzt nicht. Dachte wirklich das es sich immer bei static nur um methoden/Funktionen handelt. Ist das mit dem decimalformat(Programm 2) auch eine Klassenvariable ? Sie hat ja keinen Variablentyp

 

[Meldanor]

Allgemein:
Kommentare sind nicht dazu da, zu sagen:

void tick()       // methode tick

sondern um zu sagen, was dort passiert wie

void tick()       // Die Methode kümmert sich um die Umwandlung von Sekunden zu Minuten

Kommentare dienen dazu, dass man selber schnell sich im Quellcode zurechtfinden kann und andere das kennenlernen des Quellcode erleichtert.
dass es eine Methode ist, erkennen viele sofort, nur es geht darum:
Was macht dat Ding?

 

[eRaaaa]

Danke eRaaaa, das wusste ich jetzt nicht. Dachte wirklich das es sich immer bei static nur um methoden/Funktionen handelt. Ist das mit dem decimalformat(Programm 2) auch eine Klassenvariable ? Sie hat ja keinen Variablentyp

in programm 2 sehe ich kein DecimalFormat, aber falls du programm 1

static DecimalFormat // statische funktion
    f1 = new DecimalFormat("00"), // objekt mit dem 2 x 0 Format
    f2 = new DecimalFormat("000");

meinst, dann ja.
da steht ja eig.:

static DecimalFormat f1 = new DecimalFormat("00");
static DecimalFormat f2 = new DecimalFormat("000");

 

[diggaa1984]

habe mal die kritischen stellen korrigiert

Programm 1

import java.io.*;
import java.text.*;

class Timer
{
  static PrintWriter out = new PrintWriter(System.out, true); 

  static DecimalFormat
    f1 = new DecimalFormat("00"), // statisches objekt mit dem 2 x 0 Format
    f2 = new DecimalFormat("000"); // statisches objekt mit dem 3 x 0 Format

  int min, sek, tsdSek;

  void stelle(int min, int sek, int tsdSek)
  {
    this.min    = min;
    this.sek    = sek;
    this.tsdSek = tsdSek;
  }

  void tick()
  {
    if (++tsdSek == 1000)
    {
      tsdSek = 0;
      if (++sek == 60)
      {
        sek = 0;
        min++;
      }
    }
  }

  void zeigeAn()
  {
    out.println(
      f1.format(min) + ":" + f1.format(sek) + ":" + f2.format(tsdSek));
  }

  // gibt ZeigeAn werte als String aus
  /* koennte man so stehen lassen, wenn Tatsache die obere Methode verwendet werden wuerde,
   * momentan wird einfach der identische String wie oben ausgegeben. Wichtig ist auch, dass die
   * Methode toString aus der ObjectKlasse kommt und hier ueberschrieben wird.*/
  public String toString()
  {
    return "Zeit: "
      + f1.format(min) + ":" + f1.format(sek) + ":" + f2.format(tsdSek);
  }
}

Programm 2

class SignalTimer extends Timer // Von der Klasse Timer erben
{
  final static char SIGNAL = 7;    // finae statische Variable mit dem Wert 7
  boolean aktiv = false;  
  int minSig, sekSig, tsdSekSig;
    
  void sigTick()
  {
    tick();	
    
    if (aktiv) 	
    {
      if ((min == minSig) && (sek == sekSig) && (tsdSek == tsdSekSig))
      {
        Timer.out.print(SIGNAL);  // In Timer ueber statische variable out Inhalt von Signal ausgeben
        Timer.out.flush(); // Inhalt explizit rausschreiben
        aktiv = false;
      }
    }
  }
    
  public String toString()
  {
    return super.toString() // toString von der Timer Klasse aufrufen und folgendes ranhaengen
      + "  Signalzeit: " 
      + Timer.f1.format(minSig) + ":" 
      + Timer.f1.format(sekSig) + ":" 
      + Timer.f2.format(tsdSekSig) 
      + (aktiv ? " aktiviert" : " nicht aktiviert");
    }        
}

Programm3

class TimerTB
{
  final static int N = 5000;  // finale statische variable N mit 5000 initialisieren

  public static void main(String[] args)
  {
    SignalTimer st = new SignalTimer();
    Timer t = new Timer();

    st.aktiv = true; // dem Objetk st (Signaltimer) den wert für aktiv true überliefern
    st.tsdSekSig = 999; // dem Objekt st (Signaltimer) den wert 999 für tsdSekSig übergeben
    Timer.out.println(st); // st ueber statische variable in Timer ausgeben lassen (impliziter Aufruf von toString)
    Timer.out.println(t); // t ueber statische variable in Timer ausgeben lassen (impliziter Aufruf von toString)

    for (int i = 1; i <= N; i++)
    {
       st.sigTick();
       t.tick();
    }
    Timer.out.println(st);
    Timer.out.println(t);
  }
}

wegen dem flush() ... das kommt von hier: PrintWriter#flush

 

[Speedy85]

Vielen Dank an alle und frohe Weihnachten!