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:34 Uhr
, 08:34, 20. Mai 2018keine Bearbeitungszusammenfassung
Jneug (Diskussion | Beiträge) |
Jneug (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 77: | Zeile 77: | ||
Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>. | Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>. | ||
{{Hint:End}} | {{Hint:End}} | ||
== Beispiel einer Klasse mit Dokumentation == | == Beispiel einer Klasse mit Dokumentation == | ||
<syntaxhighlight lang="java" line="1"> | <syntaxhighlight lang="java" line="1"> | ||
import java.util.Random; | |||
/** | /** | ||
* Eine Klasse | * Eine Klasse um Zufallszahlen zu "würfeln". | ||
* @author J. Neugebauer | * Die Klasse generiert ganze | ||
* <a href="https://de.wikipedia.org/wiki/Pseudozufall">Pseudozufallszahlen</a> | |||
* von 1 bis zu einem vorher festgelegten Maximum. Um einen normalen | |||
* sechseitigen Würfel zu erzeugen benutzt man: | |||
* <pre> | |||
* Wuerfel w = new Wuerfel(6); | |||
* </pre> | |||
* Die ZUfallszahlen werden mit Hilfe von {@link java.util.Random} generiert. | |||
* | |||
* @author J. Neugebauer <schule@neugebauer.cc> | |||
* @version 2018-05-05 | * @version 2018-05-05 | ||
*/ | */ | ||
public class | public class Wuerfel { | ||
private int | private int seiten; | ||
private Random zufall; | |||
/** | /** | ||
* | * Konstruktor für Objekte der Klasse Wuerfel. | ||
* @param | * @param pSeiten Anzahl der Seiten des Würfels. | ||
*/ | */ | ||
public | public Wuerfel( int pSeiten ) { | ||
seiten = pSeiten; | |||
zufall = new Random(); | |||
} | } | ||
/** | /** | ||
* | * "Wirft" den Würfel | ||
* @return | * Es wird eine Zufallszahl zwischen 1 und dem vorher festgelegten | ||
* Maximum (einschließlich) generiert. | |||
* @return Eine Ganzzahl von 1 bis zum Maximum | |||
* @see java.util.Random#nextInt(int) | |||
*/ | */ | ||
public int | public int werfen() { | ||
return | // nextInt(int) generiert eine Zufallszahl n mit 0 <= n < 6 | ||
return zufall.nextInt(seiten)+1; | |||
} | } | ||
} | } | ||