Kommentare sind ein unverzichtbares Werkzeug in jeder Programmiersprache. So auch in Java. Sie helfen dabei, Quellcode verständlicher zu machen, Gedankengänge zu dokumentieren und komplexe Strukturen zu erklären. Der Clou: Kommentare werden vom Compiler ignoriert und haben somit keinen Einfluss auf die Programmlogik. Sie sind ausschließlich für Entwicklerinnen und Entwickler gedacht.
🔎 Warum Kommentare wichtig sind
- Lesbarkeit: Gut kommentierter Code ist leichter zu verstehen: auch nach Monaten oder Jahren.
- Teamarbeit: Andere Entwickler können schneller nachvollziehen, was dein Code tut.
- Fehlersuche: Kommentare erleichtern Debugging und Wartung.
- Dokumentation: Mit speziellen Kommentaren (/** ... */) lässt sich sogar automatisch eine HTML-Dokumentation erzeugen (Stichwort javadoc).
Beispiele für Kommentare in einem Programmode. Quelle: Technik-Kiste.de
📝 Arten von Kommentaren in Java
Java kennt drei verschiedene Kommentararten:
1. Einzeilige Kommentare
Beginnen mit // und gelten bis zum Zeilenende.
// Dies ist ein einzeiliger Kommentar
System.out.println("Hallo Welt"); // Kommentar hinter einer Anweisung
2. Mehrzeilige Kommentare (Blockkommentare)
Beginnen mit /* und enden mit */. Sie können sich über mehrere Zeilen erstrecken.
/*
Dies ist ein mehrzeiliger Kommentar.
Er eignet sich für längere Erklärungen.
*/
System.out.println("Beispielausgabe");
3. Dokumentationskommentare (javadoc)
Beginnen mit /** und enden mit */. Sie stehen direkt vor Klassen, Methoden oder Attributen und können mit dem Tool javadoc in eine HTML-Dokumentation umgewandelt werden.
/**
* Berechnet die Fläche eines Rechtecks.
* @param laenge Länge des Rechtecks
* @param breite Breite des Rechtecks
* @return Fläche als double
*/
public double berechneFlaeche(double laenge, double breite) {
return laenge * breite;
}
✅ Best Practices für Kommentare
- Klar und präzise formulieren: Kommentare sollen kurz und verständlich sein.
- Nicht Offensichtliches erklären: i = i + 1; // erhöht i um 1 ist überflüssig.
- Aktualität sicherstellen: Veraltete Kommentare sind schlimmer als gar keine.
- javadoc nutzen: Für öffentliche Methoden und Klassen immer Dokumentationskommentare schreiben.