Java Code so gut es geht Kommentieren

[iSofa]

Hallo Liebes Bord,

ich soll diesen Code so gut es geht und so einfach es geht Kommentieren. Doch leider weiß ich nicht für jede Zeile ein Schnipsel Code.

Vielleicht könnt ihr mir ja Helfen:

//Zugriff auf die Java Packet Quellen
import java.util.*;

//Neue Öffentliche Klasse mit dem Namen Fussballspiel
public class Fussballspiel {
  //Definierung der einzelnen Variablen  
  String Mannschaft1 = "";
  String Mannschaft2 = "";
  int m1Tore;
  int m2Tore;
  
  
  public static void main(String[] args){
    Fussballspiel feld = new Fussballspiel();
    feld.setNames();
    feld.printResult();
  }
  
  
  
  public void setNames() {
    //Ausgabe von Text 
    System.out.print("Geben Sie den Namen der ersten Mannschaft ein: ");
    //Aufruf des Scanner Befehls mit "new"
    Scanner sc = new Scanner(System.in);
    Mannschaft1 = sc.nextLine();
    
    //Ausgabe von Text 
    System.out.print("Geben Sie den Namen der zweiten Mannschaft ein: ");
    Mannschaft2 = sc.nextLine();
    
    //Ausgabe von Text + Methoden
    System.out.println("Es Spielt " + Mannschaft1 + " gegen "
    + Mannschaft2);
  }
  
  //Eine Random Methode 
  public void printResult() {
    Random rand = new Random();
    int m1Tore = rand.nextInt(3);
    int m2Tore = rand.nextInt(3);
    System.out.println("Ergebnis: " + Mannschaft1 +" " + m1Tore + ":" + m2Tore +" "
    + Mannschaft2);
  }
  
} // end of main

Vielen Dank schon mal

 

[Network]

Die Kommentare sind schonmal nicht gut, du wiederholst nur was der Code bereits sagt
// deklariere Variable
int i = 0;
Das hätte ich dir auch sagen können.
Kannste gerade alles wieder löschen. Grauenhaft.

Der Sinn von Kommentaren ist es einen schnellen Einblick in Codecluster zu geben ohne den Code verstehen zu müssen.

Das bedeutet auch du musst nicht vor jede Zeile einen Kommentar schreiben und erst recht nicht vor imports, packages und der main-Methode.
Die sind in jedem Programm enthalten und jeder weiß wofür die sind.

Kommentare kommen normalerweise vor Methoden, Klassen und Konstruktoren nach einem bestimmten Pattern (in Eclipse kannst du eine solche Kommentarvorlage erstellen indem du vor die Klasse '/**' schreibst und mit Enter bestätigst.) und darin beschreibst was die Methode genau macht, wofür die einzelnen Variablen sind die man übergeben muss und was genau die return Variable repräsentiert.

Ansonsten wird der Code auch häufig in verständlichere Cluster unterteilt wenn nötig.
Das ist bei so kleinem Code wie deinem meistens nicht der Fall, da der Methoden/Konstruktor-Kommentar normalerweise bereits zum Verständnis ausreichen und das sollten sie bei dir wenn du sie geschrieben hast.

 

[iSofa]

Hey ich danke dir natürlich vielmals für diese ausführliche Antwort. Das dies auch leider nicht im sinne des Erfinders ist weiß ich auch. Doch solle ich führ die Schule jede Zeile Kommentieren.

 

[Agaton Sax]

Dann weißt du doch bereits, was du zu tun hast: Nimm einfach jede Zeile und beschreibe verbal was die Anweisungen in dieser Zeile machen. Die resultierende "Dokumentation" ist dann zwar hochgradiger Schwachsinn, aber dein Lehrer ist zufrieden und du kriegst eine gute Note...

Als kleine Inspiration für in Javadoc gegossene Sinnlosigkeit:

// deklariert eine Instanzvariable names "Mannschaft1" als String und weist ihr als initialen Wert den leeren String zu
String Mannschaft1 = "";

Das hast du alles an Fachbegriffen drin, was dir eine 1 und ein Bienchen verschafft...

 

[coco07]

Agaton Sax@
Besser wäre noch: Deklariert eine Variable vom Typ String mit dem Namen Mannschaft1(entspricht nicht der Konvention für Variablen Namen) und weißt ihr einen neu erzeugten leeren String zu.
Sorry aber das musste dein :'D

Grüße Coco07!