Kommentare in Java: Unterschied zwischen den Versionen
Aus wiki.kgl-ratingen.de
(Die Seite wurde neu angelegt: „=='''Kommentare in Java'''== Programmierer, die Klassen anderer Programmierer benutzen möchten, sind auf die Informationen der Schnittstellendokumentation an…“) |
(→Die allgemeine Beschreibung der Klasse (Javadoc-Kommentare/Tags)) |
||
| Zeile 7: | Zeile 7: | ||
Beispiel: | Beispiel: | ||
| − | :::/** | + | ::: /** |
::: *Klasse Karten | ::: *Klasse Karten | ||
::: *@author M.Muster | ::: *@author M.Muster | ||
Aktuelle Version vom 13. November 2015, 16:29 Uhr
Kommentare in Java[Bearbeiten]
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)[Bearbeiten]
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.
- */
