~Java4Beginners~
~Java4Beginners~

Kommentare

Ein nicht zu unterschätzender Bestandteil der Programmierarbeit besteht mit der Dokumentation unserer Programme. In Ihrer Anfangsphase in der Programmierung ist es eigentlich nicht notwendig, ein Programm ausführlich zu dokumentieren, da der Programmumfang so gering ist, dass alles mit einem Blick erfassbar ist. Was ist allerdings mit Programmen, die aus 100 und mehr Klassen bestehen? Niemand wäre in der Lage die Übersicht zu behalten. Ein essentieller Bestandteil der Dokumentation besteht darin, seine Programme vernünftig zu kommentieren.

Typische Kommentare sind:

  • Was macht das Programm und was benötigt es.
  • Für was stehen die einzelnen Variablen.
  • Was soll beachtet werden, wenn wir diese Variable oder Methode verwenden.
  • Wie ist der Logikfluss in unserem Programm.
  • Einige Informationen über den Author und über den Code selber

Kommentare erstellen

In Java stehen uns 3 Möglichkeiten zur Verfügung, einen Kommentar zu erstellen. Kommentare werden vom Compiler nicht beachtet.

Zeilen-Kommentar

Der Zeilenkommentar wird mit // eingeleitet. Alle Zeichen, die sich rechts neben diesem Doppelslash befinden werden als Kommentar gewertet. Üblicherweise wird ein Zeilenkommentar direkt oberhalb des Bereiches, auf welchem sich der Kommentar bezieht, oder direkt rechts daneben.

        // Das hier ist ein Zeilenkommentar
    private int zahl; // Auch dass ist ein Zeilenkommentar
    
    // Das hier ist ein Zeilen-
    // kommentar über 2 Zeilen. Jede Zeile muss mit // beginnen.

Blockkommentar

Ein Blockkommentar wird mit den Zeichen /* eingeleitet. Beendet wird ein Blockkommentar mit den Zeichen */. Alles was sich zwischen /* und */ befindet, zählt als Kommentar.

        /* Hier beginnt der Blockkommentar
       Schnatter, schnatter, schnatter
       Schreib, schreib, schreib
       Hier endet der Blockkommentar */
    
    private int /*String*/ zahl1;

Javadoc-Kommentare

Javadoc-Kommentare unterscheiden sich zu den Blockkommentaren dadurch, dass Sie mit /** eingeleitet und mit */ beendet werden. Des weiteren können in Javadoc-Kommentare verschiedene Dokumentationskommentare eingefügt werden.

        /**
     * Registrierung eines Benutzers in Datenbank abspeichern
     * @param query mit Benutzerangaben
     * @author Markus Badzura
     * @version 1.0
     * @return boolean-Wert ob Eintrag register in DB erfolgreich war
     */
    public boolean registerUser(String query)
    {
            openDB();
            insertDB(query, 1);
            closeDB();    
            return register;
    }
Java stellt uns verschiedene Doc-Comments zur Verfügung. Hier eine kleine Auswahl.
Doc Comment Beschreibung
@param Beschreibung der Parameter
@see Verweis auf ein anderes Paket, einen anderen Typ, eine andere Methode oder Eigenschaft.
@version Versionsnummer
@author Entwickler der Klasse oder Methode
@return Rückgabewert der Methode
Hier handelt es sich um eine kleine Auswahl von Parametern. Auf der Homepage von Oracle finden sie weitere. Doc Comments bei Oracle.
nach oben Java4Beginners -- Seitenversion 1.0 -- Stand: 2017-04-24