Kommentare in Java

Kommentare in Java

Programmierer, die Klassen anderer Programmierer benutzen möchten, sind auf die Informationen der Schnittstellendokumentation angewiesen. Deshalb müssen alle Methoden einer Klasse dokumentiert werden.

Die allgemeine Beschreibung der Klasse (Javadoc-Kommentare/Tags)

Der erste Kommentar vor dem Kopf der Klassendefinition beschreibt den allgemeinen Zweck und die Eigenschaften der Klasse. Die Schlüsselwörter @author und @version leiten die Angabe des Autors und der Version/Datum der letzten Änderung ein. Beispiel:

/**

*Klasse Karten

*@author M.Muster

*@version 13.11.2015

*

*Die Kasse Karten beinhaltet Karten welche fuer die Oberklasse Spiel benötigt werden.

*/