8.582
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:24 Uhr
, 08:24, 20. Mai 2018→Aufbau eines JavaDoc Kommentars
Jneug (Diskussion | Beiträge) |
Jneug (Diskussion | Beiträge) |
||
| Zeile 39: | Zeile 39: | ||
* @param pMenge Methoden-Parameter, der die Menge beschreibt | * @param pMenge Methoden-Parameter, der die Menge beschreibt | ||
* @return Beschreibung des Rückgabetyps | * @return Beschreibung des Rückgabetyps | ||
* @see java.lang.Math#random() | |||
*/ | */ | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Zeile 58: | Zeile 59: | ||
; <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>. | : 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> | : Beispiel: <code>@param pTitel Titel des Objektes.</code> | ||
; <code>@return</code> | ; <code>@return</code> | ||
: Beschreibt den Rückgabewert einer Methode. Im Gegensatz zu <code>@param</code> muss kein Name angegeben werden. | |||
: Beispiel: <code>@return Eine Zufallszahl zwischen 1 und 6.</code> | |||
; <code>@see</code> | ; <code>@see</code> | ||
: | : Kann am Ende benutzt werden, um auf eine andere Methode oder Klasse zu verweisen, deren Dokumentation gegebenenfalls weiteren Aufschluss über die Funktionsweise gibt. Beispielsweise könnte eine Methode <code>werfen()</code> in der Klasse <code>Würfel</code> auf die Methode <code>random()</code> in <code>java.lang.Math</code> verweisen. | ||
: Der Verweis erfolgt entweder relativ auf ein ''Symbol'' (Attribut, Methode) der aktuellen Klasse: | |||
: Beispiel: <code>@see #werfen()</code> | |||
: oder absolut auf ein Symbol einer anderen Klasse: | |||
: Beispiel: <code>@see java.util.Random#nextInt(int)</code> | |||
; <code>@link</code> | ; <code>@link</code> | ||
: | : Links funktionieren ähnlich wie <code>@see</code>, werden aber nicht am Ende der Tags aufgeführt, sondern im Kommentartext verwendet. Dazu müssen sie in geschweiften Klammern stehen. Links können neben Symbolen auch auf Webseiten verweisen. | ||
: Beispiel: <code>Link zum Wiki: {@link https://ngb.schule/wiki}</code> | |||
: Beispiel: <code>Link zur Scanner-Klasse: {@link java.util.Scanner}</code> | |||
{{Hint:Start}} | {{Hint:Start}} | ||