24 lines
1.0 KiB
Markdown
24 lines
1.0 KiB
Markdown
|
# JavaDoc schreiben
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Lernziel
|
||
|
|
|
||
|
|
Eine vorhandene Klasse mit korrekten JavaDoc-Kommentaren versehen.
|
||
|
|
|
||
|
|
## Aufgabe
|
||
|
|
|
||
|
|
Im Paket [pr2.intro.javadoc](../sources/src/main/java/pr2/intro/javadoc/) finden Sie eine Klasse namens `Waehrung`, die eine Währung repräsentiert. Leider hat ein böser Geist bei dieser Klasse fast die gesamte JavaDoc gelöscht.
|
||
|
|
|
||
|
|
Schreiben Sie eine sinnvolle JavaDoc für die Klasse `Waehrung`, die insbesondere die Funktion der Methoden und deren Parameter und Rückgabewerte erläutert. Vergessen Sie nicht, auch die Klasse selbst zu dokumentieren.
|
||
|
|
|
||
|
|
|
||
|
|
## Abgabe (optional)
|
||
|
|
|
||
|
|
__Sie müssen keine Lösung für diese Aufgabe einreichen.__
|
||
|
|
|
||
|
|
Sie können Ihre Lösung aber auf die Konformität mit den Programmierstandards testen. Hierzu gehen Sie wie folgt vor:
|
||
|
|
|
||
|
|
1. Öffnen Sie eine Kommandozeile (Terminal).
|
||
|
|
2. Gehen Sie in Ihr Working Directory.
|
||
|
|
3. Rufen Sie mit `bin/submit.sh` das Skript auf, das die Lösungen testet und kompiliert. Wenn Maven eine Fehlermeldung zeigt, beheben Sie diese zuerst, bevor Sie mit dem nächsten Schritt fortfahren.
|