Kommentare

Kommentare sind dazu gedacht, den Quellcode für andere und auch sich selbst verständlicher zu machen. Stell dir vor, in einem Open Source Projekt würde keine einzige Zeile Code kommentiert werden. Mies oder? Deshalb empfiehlt es sich seinen Quellcode immer zu kommentieren (natürlich nur relevantes), am besten auf Englisch.

In Java gibt es 3 Arten von Kommentaren:

  • Einzeilige Kommentare
  • Mehrzeilige Kommentare
  • Javadoc Kommentare

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit '//' und enden mit der aktuellen Zeile.

Beispiel:

   public class SingleLineComment {
      public static void main(String[] args) {
         System.out.println("Gleich kommt ein Kommentar"); // Das ist ein einzeiliger Kommentar
      }
   }

Mehrzeilige Kommentare

Mehrzeilige Kommentare beginnen mit '/*' und enden mit '*/'. Dieser Kommentar kann auch mehrere Zeilen lang sein.

Beispiel:

  public class MultiLineComment {
      public static void main(String[] args) {
         System.out.println("Gleich kommt ein Kommentar"); /* Das ist ein mehrzeiliger Kommentar
                                                              Hier geht der Kommentar weiter */
      }
   }

Doc Kommentare

Doc Kommentare beginnen mit '/**' und enden mit '*/'. Da si eine Erweiterung zu den mehrzeiligen Kommentaren sind können sie ebenfalls mehrere Zeilen lang sein. Sie werden unter anderem dazu benutzt, Funktionen zu dokumentieren (Funktion, Rückgabewert etc.). Mit Hilfe des Tools javadoc können diese Kommentare extrahiert und in ein anschauliches HTML-Dokument umgewandelt werden.

Beispiel:

/** 
 * Gibt den übergebenen Parameter aus.
 * @param x   String der ausgegeben wird
 * @return    void
 */
class JavaDocComments {
    public static void printx(String x) {
        System.out.println(x);
    }
}

Die genaue Verwendung von Doc Kommentaren sowie des Javadoc Tools wird in einem eigenen Artikel erklärt.