Kommentare in Java

Kommentare sind dazu da, dem Programmierer selbst, bzw. auch evtl. anderen Programmierern, die mit dem Quelltext in Berührung kommen, eine Erklärung zu geben, was da wo genau geschieht.

In Java gibt es drei verschiedene Arten von Kommentaren:
Einzeiliger Kommentar
Mehrzeiliger Kommentar
Javadoc-Kommentar

Einzeiliger Kommentar
Jede einzeilige Kommentar beginnt mit den Zeichen „//“. Alles was danach kommt gilt dann als Kommentar und wird nicht bei der Auswertung des Programms berücksichtigt!

public void machIrgendwas() {
     String s = "...."; // dies ist ein Kommentar

     // oder auch das hier!
     hier weiterzuschreiben, ohne ein "//" davor ist nicht erlaubt!!
     es würde einen Fehler geben!

     // so geht
     // das aber
     // wohl!
}

Mehrzeilige Kommentar
Mehrzeilige Kommentare werden, wie auch scho aus andern Programmiersprachen bekannt, in Java zwischen „/*“ und „*/“ eingeschlossen!

public void machIrgendwas() {
      String s = "...."; // einzeiliger Kommentar!
      // noch einer 
      
      s = "doch n anderer String";

      /* hier kann
      ich jetzt so viel schreiben
      wie ich möchte!!
      Da es ein mehrzeiliger Kommentar ist,
      der jetzt beendet wird:
      */
}

Javadoc-Kommentar
Ein Javadoc-Kommentar beginnt mit „/**“ und endet mit „*/“ und verhält sich hierbei ähnlich dem mehrzeiligen Kommentar! Mit dessen Hilfe kann man als Benutzer eine Java Dokumentation (=Javadoc) über seinen eigenen Code anlegen. Es wird hierbei eine Reihe von html-Dateien angelegt, die die einzelnen Methoden und dazu die geschriebenen Javadoc-Kommentare -falls vorhanden- anzeigt.
So ist es einem anderen User/Programmierer sehr viel schnell klarer, was wo im Programm geschieht.

Ein Beipsiel:

	/**
	 * Die Methode erhöht die ihr übergegebene int Zahl
	 * und gibt diese dann zurück!
	 * 
	 * @param zahl wird um eins erhöht
	 * @return die um 1 erhöhte Zahl wird returnt
	 */
	public int inkrementiereZahl(int zahl) {
		
		zahl = zahl + 1; // oder auch zahl += 1, was gleichwertig wäre
		
		return zahl;
	}
	

Zu guter Letzt kommt hier noch ein Screenshot aus Eclipse. Man kann hier sehr schön sehen, dass sich Javadoc auch farblich von den anderen Kommentaren abhebt!

2 comments

  1. Ashley sagt:

    This is one awesome article post. Keep writing.

  2. We’re a group of volunteers and opening a new scheme in our community.

    Your site provided us with useful info to work on. You have done a
    formidable activity and our entire community will be thankful to you.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.