From 72a3b392afef9ad22d556f2770ec029d970abda1 Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Thu, 2 Feb 2017 11:59:18 +0100
Subject: [PATCH] Better Javadoc
---
.../de/hdm_stuttgart/sw1/klausur/Helper.java | 31 +++++++++--------
.../sw1/klausur/angebot/DummyZinsen.java | 3 ++
.../sw1/klausur/angebot/Konto.java | 6 ++--
.../de/hdm_stuttgart/sw1/klausur/Helper.java | 33 +++++++++++--------
.../sw1/klausur/angebot/DummyZinsen.java | 3 ++
.../sw1/klausur/angebot/Konto.java | 8 +++--
6 files changed, 52 insertions(+), 32 deletions(-)
diff --git a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
index c041ee74f..bab9d76b7 100644
--- a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
+++ b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
@@ -1,6 +1,10 @@
package de.hdm_stuttgart.sw1.klausur;
+/**
+ * Hilfsmethoden.
+ *
+ */
public class Helper {
/**
@@ -8,7 +12,8 @@ public class Helper {
*
* <p>{0, 1, 2, ..., 12} wird zu {"null, "eins", "zwei", ..., "zwölf"}</p>
*
- * <p>Für alle anderen Werte soll "Uuups, keine Regel für den Wert X" zurückgegeben werden.</p>
+ * <p>Für alle anderen Werte, wie z.B. »14«, soll "Uuups, keine Regel
+ * für den Wert 14" zurückgegeben werden.</p>
*
* @param a Umzuwandelnder Wert
* @return Klartextname.
@@ -18,7 +23,7 @@ public class Helper {
}
/**
- * Gibt den Betrag des Produkts der beiden Faktoren zurück.
+ * <p>Gibt den Betrag des Produkts der beiden Faktoren zurück.</p>
*
* @param a Erster Wert
* @param b Zweiter Wert
@@ -29,11 +34,12 @@ public class Helper {
}
/**
- * Der Quadrant für einen gegebenen Winkel.
- *
- * Der Vollkreis wird in 0 bis 360 Grad eingeteilt. Je nach Winkel liegt ein Vektor
- * im Quadrant 1, 2 3 oder 4:
+ * <p>Der Quadrant für einen gegebenen Winkel.</p>
*
+ * <p>Der Vollkreis wird in 0 bis 360 Grad eingeteilt. Je nach Winkel liegt ein Vektor
+ * im Quadrant 1, 2 3 oder 4:</p>
+ *
+ * <pre>
* |
* Quadrant 2 | Quadrant 1
* |
@@ -42,11 +48,10 @@ public class Helper {
* |
* |
* Quadrant 3 | Quadrant 4
- * |
+ * |</pre>
+ *
+ * <p>Beispiel: 45 Grad liegt im ersten Quadranten, 200 Grad im Dritten.</p>
*
- * Werte von einschließlich 0 bis ausschließlich 90 Grad liegen im ersten Quadranten usw.
- *
- *
* @param winkel Winkel des zu betrachtenden Vektors aus dem Intervall [0, 360[.
* @return zugehöriger Quadrant.
*/
@@ -55,9 +60,9 @@ public class Helper {
}
/**
- * Umwandlung von Sekundenangaben in das Format hh:mm:ss Beispiel:
+ * <p>Umwandlung von Sekundenangaben in das Format hh:mm:ss.</p>
*
- * 7290 Sekunden entsprechen 2 Stunden, einer Minute und 30 Sekunden, also "2:1:30"
+ * <p>Beispiel: 7290 Sekunden entsprechen 2 Stunden, einer Minute und 30 Sekunden, also "2:1:30"</p>
*
* @param sekunden Nicht-negative Sekundenangabe
* @return Angabe in Stunden:Minuten:Sekunden
@@ -69,7 +74,7 @@ public class Helper {
/**
* <p>Kehre die Reihenfolge der Werte eines Feldes um. Beispiel:</p>
*
- * <p> {1, 2, 3, 4, 5} wird zu {5, 4, 3, 2, 1}
+ * <p> {1, 2, 3, 4, 5} wird zu {5, 4, 3, 2, 1}</p>
*
* @param werte Ein Feld aus Werten oder null (keine Aktion).
*/
diff --git a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
index 673bb0e1b..7202569f7 100644
--- a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
+++ b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
@@ -7,6 +7,9 @@ package de.hdm_stuttgart.sw1.klausur.angebot;
*/
public class DummyZinsen {
+ /**
+ * @param args unused
+ */
public static void main(String[] args) {
final Konto konto = new Konto(100, 1.0, 10); // Start mit 100€, Guthabenzins 1%, Sollzins 10%
diff --git a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
index 118582b53..e20970ada 100644
--- a/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
+++ b/Klausuren/Sd1/2016summer/Exam/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
@@ -23,14 +23,16 @@ public class Konto {
}
/**
- * Diese oder alternativ die Methode {@link #neuesJahr(double)} wir einmal jährlich
+ * <p>Diese oder alternativ die Methode {@link #neuesJahr(double)} wird einmal
+ * jährlich ausgeführt.</p>
+ *
+ * <p>Die Methode bewirkt folgende Änderungen:</p>
*
* <ul>
* <li>Durchführung der Verzinsung für das zurückliegende Jahr zu aktuellen Guthaben- bzw. Schuldzinsen.</li>
* <li>Einzahlung für das jeweils nächste Jahr</li>
* <li>Anpassung von Guthaben- und Schuldzins für das kommende Verzinsungsjahr.</li>
* </ul>
- * , und .
*
* @param betrag Je nach Vorzeichen neu hinzugefügter oder abgebuchter Betrag.
* @param guthabenZins Der für das jeweils kommende Jahr geltende prozentuale Guthabenzins für nichtnegative Kontostände.
diff --git a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
index 04dfdf19d..cd1af35ed 100644
--- a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
+++ b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/Helper.java
@@ -1,6 +1,10 @@
package de.hdm_stuttgart.sw1.klausur;
+/**
+ * Hilfsmethoden.
+ *
+ */
public class Helper {
/**
@@ -8,7 +12,8 @@ public class Helper {
*
* <p>{0, 1, 2, ..., 12} wird zu {"null", "eins", "zwei", ..., "zwölf"}</p>
*
- * <p>Für alle anderen Werte soll "Uuups, keine Regel für den Wert X" zurückgegeben werden.</p>
+ * <p>Für alle anderen Werte, wie z.B. »14«, soll "Uuups, keine Regel
+ * für den Wert 14" zurückgegeben werden.</p>
*
* @param a Umzuwandelnder Wert
* @return Klartextname.
@@ -34,7 +39,7 @@ public class Helper {
}
/**
- * Gibt den Betrag des Produkts der beiden Faktoren zurück.
+ * <p>Gibt den Betrag des Produkts der beiden Faktoren zurück.</p>
*
* @param a Erster Wert
* @param b Zweiter Wert
@@ -45,11 +50,12 @@ public class Helper {
}
/**
- * Der Quadrant für einen gegebenen Winkel.
- *
- * Der Vollkreis wird in 0 bis 360 Grad eingeteilt. Je nach Winkel liegt ein Vektor
- * im Quadrant 1, 2 3 oder 4:
+ * <p>Der Quadrant für einen gegebenen Winkel.</p>
*
+ * <p>Der Vollkreis wird in 0 bis 360 Grad eingeteilt. Je nach Winkel liegt ein Vektor
+ * im Quadrant 1, 2 3 oder 4:</p>
+ *
+ * <pre>
* |
* Quadrant 2 | Quadrant 1
* |
@@ -58,11 +64,10 @@ public class Helper {
* |
* |
* Quadrant 3 | Quadrant 4
- * |
+ * |</pre>
+ *
+ * <p>Beispiel: 45 Grad liegt im ersten Quadranten, 200 Grad im Dritten.</p>
*
- * Werte von einschließlich 0 bis ausschließlich 90 Grad liegen im ersten Quadranten usw.
- *
- *
* @param winkel Winkel des zu betrachtenden Vektors aus dem Intervall [0, 360[.
* @return zugehöriger Quadrant.
*/
@@ -79,9 +84,9 @@ public class Helper {
}
/**
- * Umwandlung von Sekundenangaben in das Format hh:mm:ss Beispiel:
+ * <p>Umwandlung von Sekundenangaben in das Format hh:mm:ss.</p>
*
- * 7290 Sekunden entsprechen 2 Stunden, einer Minute und 30 Sekunden, also "2:1:30"
+ * <p>Beispiel: 7290 Sekunden entsprechen 2 Stunden, einer Minute und 30 Sekunden, also "2:1:30"</p>
*
* @param sekunden Nicht-negative Sekundenangabe
* @return Angabe in Stunden:Minuten:Sekunden
@@ -97,7 +102,7 @@ public class Helper {
/**
* <p>Kehre die Reihenfolge der Werte eines Feldes um. Beispiel:</p>
*
- * <p> {1, 2, 3, 4, 5} wird zu {5, 4, 3, 2, 1}
+ * <p> {1, 2, 3, 4, 5} wird zu {5, 4, 3, 2, 1}</p>
*
* @param werte Ein Feld aus Werten oder null (keine Aktion).
*/
@@ -129,7 +134,7 @@ public class Helper {
* </li>
* </ul>
*
- * @param isbn
+ * @param isbn Kandidat für eine gültige ISBN Nummer.
* @return true or false
*
* <p style="color: red;font-weight: bold;">Tip: Beachten Sie {@link Character#getNumericValue(char)} und {@link String#toCharArray()}.</p>
diff --git a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
index 673bb0e1b..7202569f7 100644
--- a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
+++ b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/DummyZinsen.java
@@ -7,6 +7,9 @@ package de.hdm_stuttgart.sw1.klausur.angebot;
*/
public class DummyZinsen {
+ /**
+ * @param args unused
+ */
public static void main(String[] args) {
final Konto konto = new Konto(100, 1.0, 10); // Start mit 100€, Guthabenzins 1%, Sollzins 10%
diff --git a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
index 7608b3928..8bf1cb034 100644
--- a/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
+++ b/Klausuren/Sd1/2016summer/Solution/src/main/java/de/hdm_stuttgart/sw1/klausur/angebot/Konto.java
@@ -52,18 +52,20 @@ public class Konto {
}
/**
- * Diese oder alternativ die Methode {@link #neuesJahr(double)} wir einmal jährlich
+ * <p>Diese oder alternativ die Methode {@link #neuesJahr(double)} wird einmal
+ * jährlich ausgeführt.</p>
+ *
+ * <p>Die Methode bewirkt folgende Änderungen:</p>
*
* <ul>
* <li>Durchführung der Verzinsung für das zurückliegende Jahr zu aktuellen Guthaben- bzw. Schuldzinsen.</li>
* <li>Einzahlung für das jeweils nächste Jahr</li>
* <li>Anpassung von Guthaben- und Schuldzins für das kommende Verzinsungsjahr.</li>
* </ul>
- * , und .
*
* @param betrag Je nach Vorzeichen neu hinzugefügter oder abgebuchter Betrag.
* @param guthabenZins Der für das jeweils kommende Jahr geltende prozentuale Guthabenzins für nichtnegative Kontostände.
- * @param schuldZins Der für das jeweils kommende Jahr geltende prozentuale Guthabenzins für negative Kontostände.
+ * @param sollZins Der für das jeweils kommende Jahr geltende prozentuale Guthabenzins für negative Kontostände.
*
* <p style="color: red;font-weight: bold;">Tip: Im Hinblick auf das Journal in {@link #getJournal()} können Sie alle
* benötigten Informationen in einer {@link StringBuffer} Instanzvariablen sammeln. Sinngemäß gilt dies auch für den jeweils
--
GitLab