Kommentare in Java: Unterschied zwischen den Versionen

Aus FI-Wiki
Die Seite wurde neu angelegt: „== 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 === {| class="wikitable" style="width:100%; text-align:…“
 
Keine Bearbeitungszusammenfassung
 
Zeile 1: Zeile 1:
== Kommentare in Java ==
Kommentare sind Textstellen im Java-Code, die von der JVM ignoriert werden.   
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.
Sie dienen ausschließlich dazu, den Code für Menschen verständlicher zu machen.
Zeile 10: Zeile 8:
* Übungen und Aufgaben zu kommentieren   
* Übungen und Aufgaben zu kommentieren   


=== Arten von Kommentaren in Java ===
== Arten von Kommentaren in Java ==


{| class="wikitable" style="width:100%; text-align:center;"
{| class="wikitable" style="width:100%; text-align:center;"
Zeile 30: Zeile 28:
|}
|}


=== Einzeiliger Kommentar ===
== Einzeiliger Kommentar ==
Ein Kommentar, der nur bis zum Zeilenende gilt:
Ein Kommentar, der nur bis zum Zeilenende gilt:


Zeile 38: Zeile 36:
</syntaxhighlight>
</syntaxhighlight>


=== Mehrzeiliger Kommentar ===
== Mehrzeiliger Kommentar ==
Ein Kommentarblock über mehrere Zeilen hinweg:
Ein Kommentarblock über mehrere Zeilen hinweg:


Zeile 48: Zeile 46:
</syntaxhighlight>
</syntaxhighlight>


=== Beispiel: Einsatz von Kommentaren ===
== Beispiel: Einsatz von Kommentaren ==
<syntaxhighlight lang="java">
<syntaxhighlight lang="java">
public class Kommentare {
public class Kommentare {
Zeile 66: Zeile 64:
</syntaxhighlight>
</syntaxhighlight>


=== Wozu sind Kommentare NICHT gedacht? ===
== Wozu sind Kommentare '''NICHT''' gedacht? ==
* nicht zum Ausschalten ganzer Programmteile (nur im Notfall)   
* nicht zum Ausschalten ganzer Programmteile (nur im Notfall)   
* nicht zum Ersetzen von gutem Code   
* nicht zum Ersetzen von gutem Code   
Zeile 75: Zeile 73:
</syntaxhighlight>
</syntaxhighlight>


=== Gute Kommentare beschreiben das WARUM, nicht das WAS ===
== Gute Kommentare beschreiben das WARUM, nicht das WAS ==
Schlecht:
Schlecht:
<syntaxhighlight lang="java">
<syntaxhighlight lang="java">
Zeile 88: Zeile 86:
</syntaxhighlight>
</syntaxhighlight>


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

Aktuelle Version vom 12. Januar 2026, 15:24 Uhr

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.