JavaDoc Kommentare

Wir haben uns soeben schon mit dem Thema Kommentare beschäftigt:

// Das ist ein Kommentar, er ist ausschließlich für die Programmierenden gedacht.
/* Dies ist ein mehrzeiliger Kommentar,
   er kann über beliebig viele Zeilen gehen.
   Allerdings sollte man vorsichtig sein, da man ihn nicht verschachteln kann,
   es ist somit sinnvoll, Codezeilen, die man gerade nicht verwenden will,
   mit einzeiligen Kommentaren zu neutralisieren, das bietet den Vorteil, dass man,
   wenn man kurzzeitig einige duzende oder hunderte Zeilen auskommentieren will,
   diese mit einem mehrzeiligen Kommentar umklammern kann */

 /** 
  * Eine weitere Möglichkeit mehrzeilige Kommentare zu erstellen, stellen die sogenannten JavaDoc-
  * Kommentare dar, sie bieten die Möglichkeit den Code auf eine Art und Weise zu kommentieren,
  * welche das Programmieren sehr vereinfacht. Der einzige Unterschied gegenüber normalen,
  * mehrzeiligen Kommentaren ist der zweite Stern am Anfang, die Sterne am Anfang jeder neuen 
  * Zeile sind optional aber üblich.
  */

Wenn man im Quellcode auf eine Variable, Methode oder Klasse (dazu später noch mehr) klickt und anschließend Strg + Q drückt, erscheint ein kleines Popup mit einer hoffentlich hilfreichen Javadoc Kommentation. Bei Eclipse muss man bei Standardeinstellungen mit dem Mauszeiger nur auf ein solches Element hovern, um die Dokumentation dazu einzublenden.

JavaDoc Kommentare werden bei größeren Projekten sehr wichtig, sie werden vor eine Variable, Methode oder Klasse geschrieben.

package serlo;

// import java.util.Scanner;

/**
 * Testklasse um diverses Zeug zu testen
 *
 * @since 17.03.2015
 */
public class Testklasse {

    /**
     * Zeugs
     *
     * @param args
     * @since 17.03.2015
     */
    public static void main(String[] args) {
        /** Eine supergeheime Variable */
        int illuminati = 420;

        System.out.println(illuminati);
    }

}

@param o.ä. wird als Tag bezeichnet, damit lassen sich Zusatzinformationen speichern.

Wenn man gute JavaDoc-Kommentare gemacht hat, kann man später bei großen Projekten eine sogenannte JavaDoc-Dokumentation erstellen lassen, welche anderen Programmierern dann erklärt, welche Methoden was erledigen (somit kann man den Code von anderen Leuten verwenden, ohne sich die Methoden ansehen zu müssen).

Kommentieren Kommentare