Java Kommentare

In Java sind Kommentare nicht ausführbare Anweisungen, die Erklärungen oder Anmerkungen innerhalb des Codes enthalten. Sie werden verwendet, um die Lesbarkeit des Codes zu verbessern und den Entwicklern zu helfen, den Zweck und die Funktionalität des Codes zu verstehen. Kommentare werden vom Java-Compiler während der Ausführung ignoriert.

Arten von Kommentaren

Java unterstützt drei Arten von Kommentaren:

1. Einzeilige Kommentare
2. Mehrzeilige Kommentare
3. Dokumentation Kommentare

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit // und gehen bis zum Ende der Zeile. Sie werden für kurze Erklärungen oder Notizen innerhalb des Codes verwendet.

Syntax

 // This is a single-line comment
int number = 10; // This initializes the variable

Mehrzeilige Kommentare

Mehrzeilige Kommentare, auch Blockkommentare genannt, beginnen mit /* und enden mit */. Sie sind nützlich, um mehrere Codezeilen auszukommentieren oder detaillierte Erklärungen zu geben.

Syntax

 /*
This is a multi-line comment.
It can span multiple lines.
*/
int number = 20;

Dokumentation Kommentare

Dokumentationskommentare oder Javadoc-Kommentare sind spezielle Kommentare, die zur Erstellung der API-Dokumentation verwendet werden. Sie beginnen mit /** und enden mit */. Diese Kommentare werden normalerweise vor Klassen-, Methoden- oder Felddeklarationen platziert, um deren Zweck und Verwendung zu beschreiben.

Syntax

 /**
 * This is a documentation comment.
 * @param args Command line arguments
 */
public static void main(String[] args) {
    // Code goes here
}

Beispiele

Beispiel 1: Einzeilige Kommentare verwenden

 public class SingleLineCommentExample {
    public static void main(String[] args) {
        // Print a message to the console
        System.out.println("Hello, World!"); // Output message
    }
}

Beispiel 2: Mehrzeilige Kommentare verwenden

 public class MultiLineCommentExample {
    public static void main(String[] args) {
        /*
         * This block of code prints a message
         * to the console.
         */
        System.out.println("Hello, Java!");
    }
}

Beispiel 3: Kommentare zur Dokumentation verwenden

 /**
 * The Calculator class provides basic arithmetic operations.
 */
public class Calculator {
    /**
     * Adds two integers.
     * @param a First integer
     * @param b Second integer
     * @return Sum of a and b
     */
    public int add(int a, int b) {
        return a + b;
    }
}

Javadoc Tags

Javadoc-Kommentare können bestimmte Tags enthalten, die zusätzliche Informationen über die beschriebenen Code-Elemente liefern. Zu den häufig verwendeten Tags gehören:

• @param: Beschreibt einen Methodenparameter.
• @return: Beschreibt den Rückgabewert einer Methode.
• @throws oder @exception: Dokumentiert eine Ausnahme, die von einer Methode ausgelöst wurde.

Tipps und bewährte Praktiken

• Klarheit: Verwende Kommentare, um komplexe Codelogik zu verdeutlichen, aber vermeide es, das Offensichtliche auszusprechen.
• Konsistenz: Behalte einen einheitlichen Stil für Kommentare in der gesamten Codebasis bei.
• Kommentare aktualisieren: Stelle sicher, dass die Kommentare bei Codeänderungen aktualisiert werden, um Unstimmigkeiten zu vermeiden.
• Vermeide es, zu viele Kommentare zu schreiben: Verwende nicht zu viele Kommentare; der Code sollte nach Möglichkeit selbsterklärend sein.
• Javadoc: Verwende Javadoc-Kommentare für öffentliche APIs, um die automatische Erstellung der Dokumentation zu erleichtern.