8.581
Bearbeitungen
Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc (Quelltext anzeigen)
Version vom 20. Mai 2018, 08:11 Uhr
, 08:11, 20. Mai 2018→Aufbau eines JavaDoc Kommentars
Jneug (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Jneug (Diskussion | Beiträge) |
||
| Zeile 50: | Zeile 50: | ||
; <code>@author</code> | ; <code>@author</code> | ||
: Name des oder der Autoren. Macht i.d.R. nur Sinn bei Klassen. | : Name des oder der Autoren. Macht i.d.R. nur Sinn bei Klassen. | ||
: Beispiel: <code>@author J. Neugebauer <schule@neugebauer.cc></code> | |||
: Beispiel: <code>@author Ngb, Smr, Dop</code> | |||
; <code>@version</code> | ; <code>@version</code> | ||
: | : Legt die Version der Klasse fest. Maximal einmal pro Klasse oder Interface verwenden. Die Version wird entweder über ein Datum festgelegt, oder über eine Versionsnummer. Für Versionsnummern gibt es keinen einheitlichen Standard, weit verbreitet ist aber das [https://semver.org Semantic Versioning]. | ||
: Beispiel: <code>@version 2018-05-20</code> | |||
: Beispiel: <code>@version 1.0.1</code> | |||
; <code>@param</code> | ; <code>@param</code> | ||
: | : Beschreibt den Parameter einer Methode oder eines Konstruktors. Das Format der Einträge ist <code>@param ''pName'' ''Beschreibung''</code>. | ||
: Beispiel: <code>@param pTitel Titel des Objektes</code> | |||
; <code>@return</code> | ; <code>@return</code> | ||
; <code>@see</code> | ; <code>@see</code> | ||
: | : | ||