Kommentare in Java

Aus FI-Wiki

Kommentare in Java

Kommentare sind Textstellen im Java-Code, die von der JVM ignoriert werden. Sie dienen ausschließlich dazu, den Code für Menschen verständlicher zu machen.

Kommentare helfen dabei:

  • den Code zu dokumentieren
  • komplexe Stellen zu erklären
  • Schritte im Programm klarer zu strukturieren
  • Übungen und Aufgaben zu kommentieren

Arten von Kommentaren in Java

Kommentarart Schreibweise Beschreibung
Einzeiliger Kommentar // Kommentar Gilt nur für eine einzelne Zeile.
Mehrzeiliger Kommentar /* Kommentar */ Kann sich über mehrere Zeilen erstrecken.
Dokumentationskommentar /** Kommentar */ Für automatische Dokumentation (JavaDoc), später relevant.

Einzeiliger Kommentar

Ein Kommentar, der nur bis zum Zeilenende gilt:

// Dies ist ein einzeiliger Kommentar
int zahl = 10;  // Kommentar hinter Code

Mehrzeiliger Kommentar

Ein Kommentarblock über mehrere Zeilen hinweg:

/*
 Dies ist ein mehrzeiliger Kommentar.
 Er kann beliebig viele Zeilen umfassen.
*/

Beispiel: Einsatz von Kommentaren

public class Kommentare {
    public static void main(String[] args) {

        // Benutzerbegrüßung
        System.out.println("Hallo!");

        /*
         Ausgabe der Zahl:
         Der Wert kann beliebig geändert werden.
        */
        int zahl = 5;
        System.out.println(zahl);
    }
}

Wozu sind Kommentare NICHT gedacht?

  • nicht zum Ausschalten ganzer Programmteile (nur im Notfall)
  • nicht zum Ersetzen von gutem Code
  • nicht für offensichtliche Dinge wie:
// Variable wird auf 5 gesetzt
int x = 5;

Gute Kommentare beschreiben das WARUM, nicht das WAS

Schlecht:

// Zahl wird um 1 erhöht
zahl = zahl + 1;

Gut:

// erhöht die Versuchsanzahl, um die Schleife zu steuern
zahl = zahl + 1;

Kurz gesagt

  • Einzeilige Kommentare beginnen mit `//`.
  • Mehrzeilige Kommentare stehen zwischen `/* ... */`.
  • Kommentare machen Code verständlicher – sie erklären Gedanken, nicht offensichtliche Befehle.