Kommentare in Java

Kommentare sind in jeder Programmiersprache ein essentielles Mittel, von dem man stets Gebrauch machen sollte. Ich möchte sogar sagen, guter Code ist auf jeden Fall kommentiert. Die Gründe hierfür sind vielseitig.

Stell Dir nur mal vor, Du schreibst ein komplexes Programm, legst es zur Seite und schaust Dir den Code nach 1-2 Jahren wieder an. Wie schnell verstehst Du, ohne Kommentare, was Du Dir hier und da gedacht hast? Warum Du diese oder jene Designentscheidung getroffen hast? Gibst Du denn Code an Dritte weiter, wird es für diese nochmals schwerer.
Um Dir und auch Kollegen oder Freunde, mit denen Du zusammen programmierst, die Zeit der Einarbeitung und auch der Missverständnisse möglichst gering zu halten, solltest Du auf jeden Fall stets kommentieren.

Welche Arten von Kommentaren kennt Java?

Generell gibt es drei verschiedene Arten:
  • Einzeiliger Kommentar
     public void foo() {
      // dies ist ein einzeiliger Kommentar
     }
    
  • Mehrzeiliger Kommentar
     public void foo() {
      /*
       Dies ist ein mehrzeiliger
       Kommentar
      */
     }
    
  • Javadoc-Kommentar
      /**
       * Diese Methode konkateniert die beiden, ihr übergebenen Strings
       *
       * @param s1
       * @param s2
       * @return
       */
      public String concat(String s1, String s2) {
    
        return s1 + s2;
      }
    


Letzterer ist zwar auch mehrzeilig, geht aber noch einen Schritt weiter:
Aus den Javadoc-Kommentaren kannst Du Dir später mit Java-Bordmitteln eine eigene Dokumentation, ähnlich der Java-API, exportieren.
Mit Hilfe dieses Exports (z.B. als html-Datei) kannst Du dann auf einen Blick sehen, welche Attribute und Methoden Deine Klassen haben, welche Parameter Du benötigst, um diese aufzurufen, etc. Vorausgesetzt natürlich, Du hast Deine Hausaufgaben während des Programmierens gemacht und immer fleißig kommentiert.

Auch wenn alle Arten von Kommentaren mehr oder weniger dasselbe tun, gibt es doch Unterschiede wann und wo man welchen nutzen sollte.
Hinzu kommt noch, dass die Syntax der „mehrzeiligen Kommentare” varieren kann. Interessanterweise handhaben die verschiedenen IDEs diese auch unterschiedlich.

Aber dazu mehr im Kurs.
Du möchtest mehr über das Thema der Kommentare erfahren?
Created with