Labor – JavaDoc, Math und String-Methoden

1. Javadoc lesen

Suche im Internet nach den Java-Klasse Math (genauer: java.lang.Math) und String (genauer: java.lang.String) und schreibe in einigen deutschen!! Sätzen eine Kurzanleitung/Beschreibung.

Diese soll NICHT in Word, sondern in der README.TXT-Datei in BlueJ geschrieben werden!
Tu dies für die folgenden Methoden:

  • Math.sqrt(value)

  • aTxt.startsWith(aTxtPiece)

  • aTxt.contains(aTxtPiece)

  • aTxt.endsWith(aTxtPiece)

Gib dabei Erläuterungen zur Grundfunktion, den Parametern und den Rückgabewerten, gib auch jeweils mindestens 1 Beispiel an.

Anleitung (Vorschlag):

  • Suche im Internet z.B. mit "javadoc 14 math" (14 bedeutet die Java-Version, aktuell ist 15, sinnvoller Mindestwert ist dzt. 8) nach der passenden Dokumentations-Datei. Diese gibt es normalerweise NUR in Englisch!

  • Einer der obersten Einträge sollte docs.oracle.com im Text enthalten - das sollte der richtige Treffer sein.

  • Lösche den Standard-Inhalt der bei jedem BlueJ-Projekt verfügbaren Datei README.TXT

  • Erstelle die Überschriften - siehe Beispiel unten.

  • Kopiere die Kurzbechreibung aus dem Block Method Summary in dein Dokument (dort kann/soll sie auch stehen bleiben)

  • Übersetze sie salopp mit eigenen Worten (keine Kopien innerhalb der Klasse!!) auf deutsch

  • Klicke auf den Methodennamen in der Kurzbeschreibung (ist ein Link). Damit kommst du zu den Details

  • Fasse die Details salopp, ungefähr analog zu den Beispielen unten zusammen.

Beispiele dazu:

Math.random()
=============
[Orig] Returns a double value with a positive sign, greater than or equal to 0.0 and less than 1.0.

Rückgabewert ist eine nicht-negative double-Zahl zwischen 0.0 (inklusive) und 1.0 (exclusive).

Ist eine Klassenmethode - wird am Klassennamen aufgerufen, NICHT an einem erzeugten Objekt!

Beim ersten Aufruf wird ein Zufallszahlengenerator erzeugt, der ab dann immer wieder verwendet wird, um bei Methodenaufruf eine neue Zufallszahl (Details siehe oben) zurückzuliefern.

Nutzungsbeispiel:
double randVal = Math.random();  // nun ist in  randVal  ein zufälliger Zahlenwert zw. 0 und < 1 enthalten.


aTxt.equals(otherTxt)
=====================
[Orig] Compares this string to the specified object.

Vergleicht den String  aTxt  mit dem als Parameter übergebenen  otherTxt .

Ist eine Instanzmethode - wird an einem String-Objekt aufgerufen, nicht am Klassennamen.

Parameter: der Text, der mit dem in  aTxt  enthaltenen Text verglichen werden soll.
Rückgabewert: boolean, true nur dann, wenn  otherTxt  mit  aTxt  übereinstimmt.

Nutzungsbeispiel:
String aTxt = "Schule ist SCHÖN";
if (aTxt.equals("Schule ist SCHÖN")) {            // <------ hier die Verwendung --------
    System.out.println("beide Texte sind gleich");
}
...

2. Konstante PI und Quadratwurzel-Methode

Erstelle eine Klasse Halbreis, die als einzige Eigenschaft den Radius hat. Es gibt nur einen Konstruktor mit dem Radius als Parameter sowie folgende Methoden:

  • double berechneUmfang() …​ addiert den halben Kreisumfang und den Durchmesser (diese beiden bilden den Umfang des Halbkreises) und liefert den Wert zurück

  • double berechneFlaeche() …​ berechnet die halbe Kreisfläche und liefert sie zurück

  • void printInfo() …​ gibt Objekt-Information aus in der Form (hier für Radius 3.0):

  ***** Halbkreis *****
  * Radius: 3.0
  * Umfang: 15.424777...
  * Fläche: 14.137166...

Erstelle weiters eine Klasse RechtWinkelDreieck, die per Konstruktor die beiden kürzeren Seiten a, b mittels Parametern als Eigenschaften setzt. Sie hat nur 2 Methoden:

  • double hypotenuse() …​ berechnet die Hypotenuse mittels pythagoräischem Lehrsatz (Zum Wurzelziehen - englisch square root - wird die passende Methode der Klasse Math genutzt).

  • void printInfo() …​ analog zu oben.

3. String-Methoden

Schreibe eine Klasse TextSuche mit einer einzigen Eigenschaft: String txt.

  • Konstruktor mit einem Text als Parameter.

  • Methode void beginntMit(String suchTxt) …​ gibt auf dem Bildschirm aus (für txt: "Hallo Alle!", suchTxt: "Hall"):
    Text 'Hallo Alle!' beginnt mit 'Hall'
    Falls txt nicht mit suchTxt beginnt, soll ausgegeben werden:
    Text 'Hallo Alle!' beginnt NICHT mit 'Hall'

Analog sind die beiden Methoden endetMit(…​) und enthaelt(…​) zu implementieren.

4. Javadoc schreiben

Erstelle zu den beiden Klassen Zahlenvergleich und Rechteck (siehe Labor-Aufgabe von 2020-11-05) Javadoc-Kommentare.

Kopiere als erste Rohfassung die in der Aufgabenstellung enthaltenen Informationen an die geeigneten Stellen und verfeinere Formulierung, Formatierung.

Weiters ergänze an passenden Stellen die Dokumentations-Tags @author, @version, @param, @return und füge für Zeilenschaltungen <br> ein.

Beachte auch, dass der erste Satz (bis zum ersten '. ' …​ Punkt, danach Leerzeichen) besondere Bedeutung hat, da er in der Übersicht angezeigt wird.