Prozeduren, Funktionen, Datenströme, JavaDoc

Transkript

1 Prozeduren, Funktionen, Datenströme, JavaDoc Thomas Röfer Unterprogramme, Prozeduren und Funktionen Formale Parameter Überladen von Funktionen Rekursion Dokumentieren von Quelltexten Datenströme

2 Rückblick Anweisungen, Verzweigungen und Schleifen Variablendeklaration typ bezeichner [ ausdruck ], bezeichner [ ausdruck ] ; Zuweisungen l-wert [ operator ] ausdruck ; Erhöhen/verringern einer Variablen ( ) bezeichner ; bezeichner ( ) ; Funktionsaufruf [ ausdruck. ] bezeichner ( [ ausdruck, ausdruck ] ) ; Zusicherung und Ausnahmen assert bedingung [ : ausdruck ] ; throw ausdruck ; Ausnahmen fangen try anweisung catch ( typ bezeichner ) anweisung [ finally anweisung ] Verzweigungen if ( bedingung ) anweisung [ else anweisung ] switch ( ausdruck ) ( case konstausdruck default ) : anweisung Schleifen while ( bedingung ) anweisung do anweisung while ( bedingung ) ; for ( [ initialisierungen ] ; [ bedingung ] ; [ aktualisierungen ] ) anweisung Marke, Abbruch, Fortsetzung, Rückgabe bezeichner : break [ bezeichner ] ; continue [ bezeichner ] ; return [ ausdruck ] ; Block anweisung PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 2

3 Unterprogramme Ziele Wiederverwendung von Berechnungen Strukturierung von Programmen Funktionen Unterprogramme mit Rückgabewert (Ergebnis) Können Seiteneffekte haben, z.b. Attribute eines Objekts ändern Prozeduren Unterprogramme ohne Rückgabewert In Java: Funktionen mit Rückgabetyp void Müssen Seiteneffekte haben, z.b. Attribute eines Objekts ändern oder etwas auf der Konsole ausgeben int intmod(int mod(inta, a, int intb) b) if(a if(a < b) b) return returna; a; else else return returnmod(a b, b, b); b); void voidprintmod16(int printmod16(intx) x) System.out.println( System.out.println( mod(x, mod(x, 16)); 16)); PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 3

4 Teile eines Unterprogramms Kopf (Signatur / Aufrufschnittstelle) Name des Unterprogramms Namen und Typen der formalen Parameter Ergebnistyp Rumpf Anweisungsblock mit Berechnungsvorschriften Kann lokale Variablen vereinbaren Aufruf Belegung der formalen Parameter mit passenden aktuellen Parametern und Ausführung des Anweisungsblocks int intmod(int mod(inta, a, int intb) b) if(a if(a < b) b) return returna; a; else else return returnmod(a b, b, b); b); void voidprintmod16(int printmod16(intx) x) System.out.println( System.out.println( mod(x, mod(x, 16)); 16)); PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 4

5 Formale Parameter Eingabeparameter Nur Übergabe von Werten an Funktion In Java: Werden Objekte übergeben, kann nicht angegeben werden, dass eine Funktion diese nicht ändern wird Ausgabeparameter Funktion liefert Ergebnis (teilweise) in Parametern zurück Seiteneffekte (?) In Java: Nur durch Übergabe von Referenzen auf Objekte zu realisieren, wobei die Funktion den Inhalt der Objekte ändert Transiente Parameter Parameter werden sowohl zur Eingabe, als auch zur Ausgabe genutzt int intmod(int mod(inta, a, int intb) b) return returna --a b ** b; b; void voiddivmod(int divmod(inta, a, int intb, b, Value Valued, d, Value Valuer) r) d.value d.value a b; b; r.value r.value a --d.value d.value ** b; b; void voidswap(value swap(valuea, a, Value Valueb) b) int intt t a.value; a.value; a.value a.value b.value; b.value; b.value b.value t; t; PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 5

6 Überladen von Funktionen Definition Eine Funktion ist überladen, wenn mehrere Funktionen mit gleichem Namen im selben Sichtbarkeitsbereich definiert werden, die sich in ihrer Signatur unterscheiden In Java müssen sich überladene Funktionen durch die Typen ihrer formalen Parameter unterscheiden, ein ausschließlich unterschiedlicher Rückgabetyp reicht nicht Beispiele plus : int intint static int plus(int a, int b) return a + b; plus : float float float static float plus(float a, float b) return a + b; plus : int intfloat Nicht zulässig, da Parameterliste identisch mit plus : int intint PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 6

7 Überladene Funktionen Aufruf Definition Es wird immer die speziellste Überladung aufgerufen, d.h. diejenige, die die wenigsten automatischen Typerweiterungen erfordert Ist dies nicht eindeutig, erzeugt der Übersetzer einen Fehler Beispiel 1 plus : int longint plus : long longlong Aufruf plus(1, 2) wählt Überladung 1, plus(1l, 2) wählt Überladung 2 Beispiel 2 plus : long intlong (Zusätzlich zu Beispiel 1) Aufruf plus(1, 2) ist mehrdeutig, da die Überladungen 1 und 3 gleich viele Typerweiterungen erfordern PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 7

8 Aufruf von Objekt-Methoden Definition Beim Aufruf einer Objekt-Methode wird ein versteckter Parameter mit übergeben, die this- Referenz Java nutzt diese Referenz, um auf Objekt- Attribute und -Methoden zuzugreifen Sie kann aber auch direkt verwendet werden, falls die Referenz benötigt wird oder um Mehrdeutigkeiten aufzulösen Signaturen copyfrom : Name Name copyto : Name Name class classname String String name; name; void voidcopyfrom(name copyfrom(namename) this.name this.name name.name; name.name; void voidcopyto(name copyto(nameother) other) other.copyfrom(this); other.copyfrom(this); Name Name a, a, b; b; a.name a.name "Markus"; "Markus"; a.copyto(b); a.copyto(b); PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 8

9 Rekursion Rekursiver Aufruf Eine Funktion ruft sich selbst auf Verschränkt rekursiver Aufruf Funktionen rufen sich gegenseitig immer wieder auf Endrekursion Ist der rekursive Aufruf in einer Funktion die letzte Anweisung, ist sie endrekursiv Eine Endrekursion kann immer durch eine Iteration ersetzt werden Komplexität Mehrfach (nicht primitiv) rekursive Funktionen können schnell wachsen Beispiel: Fibunacci-Zahlen Beispiel: Ackermann-Funktion (s. Buch) b + 1 A( a, b) A( a 1,1) A( a 1, A( a, b 1)) PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 9 int intmod(int mod(inta, a, int intb) b) if(a if(a < b) b) return returna; a; else else return returnmod2(a, b); b); int intmod2(int mod2(inta, a, int intb) b) return returnmod(a mod(a--b, b, b); b); falls a falls b sonst 0 0

10 Java ohne BlueJ Deklaration Enthält eine Klasse eine Funktion mit der Signatur >java Klasse Hallo "dies und das" Aufruf public static void main(string[ ] args) so kann diese von der Konsole aus aufgerufen werden Virtuelle Maschine java Name der Klasse, die main enthält Eventuelle Parameter für main Die Parameter werden als String- Array übergeben String[] String[] args args args.length args[0] args[1] args[2] 3 "Hallo" "21333" "dies und das" public static void main(string[ ] args)... PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 10

11 Beispiel class classgreetings public publicstatic staticvoid voidmain(string[ ]] args) args) for(int for(inti i 0; 0; i i < args.length; ++i) ++i) if(args[i].equals("walter")) System.out.println("Mein Gott Gott "" + args[i]); else else System.out.println("Hallo "" + args[i]); PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 11

12 Dokumentieren von Quelltexten Klassen Allgemeine Beschreibung, was die Aufgabe der Klasse ist Attribute Was wird in dem Attribut gespeichert? Haben bestimmte Belegungen besondere Bedeutungen? Methoden Was tut die Methode? Welche Parameter hat sie und was bedeuten sie? Welches Ergebnis liefert die Methode? Welche Seiteneffekte hat die Methode? Was sind die Vorbedingungen für die Anwendbarkeit der Methode? Welche Nachbedingungen sind erfüllt? PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 12

13 Dokumentieren von Quelltexten In externen Dokumenten Wie ist die Gesamtarchitektur des Programms? Wie arbeiten die Klassen zusammen? Wie benutzt man das Programm? Kommentare in Java Zeilen-Kommentar: Dies ist ein Kommentar bis zum Zeilenende Block-Kommentar: /* Dies ist ein Kommentar bis zur Endmarkierung */ JavaDoc-Kommentar: /** Dies ist ein JavaDoc-Kommentar */ JavaDoc Ein Übersetzer, der aus einem Java-Quelltext eine Dokumentation erstellt Die Dokumentation wird im HTML-Format (Hyper Text Markup Language) erzeugt In JavaDoc-Kommentaren kann deshalb auch HTML verwendet werden Aufruf in BlueJ aus dem Texteditor PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 13

14 JavaDoc-Schlüsselwörter autorenname Angabe des Autors, Thomas <a versionsnummer Angabe der Versionsnummer, hinweistext Die/das Klasse/Methode/Attribut soll nicht mehr verwendet werden, Verwenden Sie stattdessen bitte versionsnummer Die Klasse/Methode funktioniert erst seit einer bestimmten Version, 3.13 PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 14

15 JavaDoc-Schlüsselwörter parametername beschreibung Beschreibung eines Funktionsparameters, month Der Monat, für den die Hasenpopulation errechnet werden beschreibung Beschreibung des Rückgabewerts, Die Anzahl der Hasenpaare im angegebenen ausnahmenname beschreibung Beschreibung von möglicherweise von einer Funktion erzeugten Ausnahmen, FalscherWertAusnahme Diese Ausnahme wird erzeugt, wenn ein falscher Monat übergeben wurde (kleiner 1 oder zu groß). PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 15

16 JavaDoc-Schlüsselwörter [ [ paket. ] klasse # ] [ methode attribut ] text Fügt einen Querverweis zu einer Methode oder einem Attribut hinzu. Der Querverweis wird als Quelltext formatiert. Verwenden Sie stattdessen #bettermethod() [ [ paket. ] klasse # ] [ methode attribut ] text aber der Querverweis wird als normaler Text [ [ paket. ] klasse # ] [ methode attribut ] text Fügt einen Verweis in einem separaten Abschnitt hinzu. Der Text muss in Anführungszeichen stehen, falls er aus mehreren Worten besteht, oder durch einen HTML-Verweis geklammert sein. "Übungsblatt #bettermethod() <a href" PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 16

17 Beispiel /** /** ** Die Die Klasse Klasse berechnet berechnet die die Hasenpopulation Hasenpopulation für für einen einen bestimmten bestimmten Monat Monat ** mit mit ganz ganz unterschiedlichen unterschiedlichen Methoden, Methoden, teils teils rekursiv, rekursiv, teils teils iterativ. iterativ. <a <a <a href" href" 4</a> 4</a> */ */ public publicclass classrabbits /** /** ** Die Die Methode Methode berechnet berechnet die die Anzahl Anzahl der der Hasenpaare Hasenpaare für für einen einen bestimmten bestimmten ** Monat Monat iterativ. iterativ. Sie Sie stellt stellt quasi quasi die die klassische klassische iterative iterative Lösung Lösung dar. monthder Der Monat, Monat, für für den den die die Hasenpopulation Hasenpopulation bestimmt bestimmt werden werden ** soll. soll. Muss Muss mindestens mindestens 11 sein. Die Anzahl Anzahl der der Hasenpaare Hasenpaare im im angegeben angegeben Monat. Monat. */ */ static staticint intcalcrabbitsi0(int calcrabbitsi0(intmonth) PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 17

18 Datenströme Allgemein Datenströme leiten Daten seriell in ein Programm hinein bzw. wieder heraus Datenströme können umgeleitet werden, so kann die Eingabe aus einer Datei kommen bzw. die Ausgabe in eine Datei geschrieben werden Standard-Datenströme Standardeingabe System.in (Instanz von InputStream) Standardausgabe System.out (Instanz von PrintStream) Standardfehlerausgabe System.err (Instanz von PrintStream) PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 18

19 Datenströme in Java Byte-orientierte Datenstöme InputStream FileInputStream, FilterInputStream, PushbackInputStream... OutputStream FileOutputStream, FilterOutputStream, PrintStream... Unicode-orientierte Datenströme Reader BufferedReader, FilterReader, InputStreamReader, StringReader... Writer BufferedWriter, FilterWriter, OutputStreamWriter, PrintWriter, StringWriter... Anmerkung Datenströme befinden sich im Paket java.io (z.b. java.io.fileinputstream) java.io. vor den Klassen kann eingespart werden, wenn der Quelltext eine Importanweisung am Anfang enthält: import java.io.* PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 19

20 Beispiel 1 import import java.io.*; java.io.*; class class Count Count static static int int count(string count(string filename) filename) throws throws FileNotFoundException, FileNotFoundException, IOException IOException FileInputStream FileInputStream stream stream FileInputStream(fileName); FileInputStream(fileName); int int chars chars 0; 0; int int c c stream.read(); stream.read(); while(c while(c!! -1) -1) ++chars; ++chars; c c stream.read(); stream.read(); return return chars; chars; PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 20

21 Beispiel 2 (Auszug) static static void void more(string more(string filename) filename) throws throws FileNotFoundException, FileNotFoundException, IOException IOException FileInputStream FileInputStream stream stream FileInputStream(fileName); FileInputStream(fileName); InputStreamReader InputStreamReader reader reader InputStreamReader(stream); InputStreamReader(stream); BufferedReader BufferedReader buffer buffer BufferedReader(reader); BufferedReader(reader); InputStreamReader InputStreamReader console console InputStreamReader(System.in); InputStreamReader(System.in); System.out.print("\f"); System.out.print("\f"); Konsole Konsole löschen löschen String String line line buffer.readline(); buffer.readline(); erste erste Zeile Zeile lesen lesen int int count count 1; 1; while(line while(line!! null) null) solange solange noch noch Zeilen Zeilen da da System.out.println(count System.out.println(count + + ":\t" ":\t" + + line); line); ausgeben ausgeben if(++count if(++count % % ) 1) alle alle Zeilen Zeilen console.read(); console.read(); auf auf Eingabe Eingabe warten warten System.out.print("\f"); System.out.print("\f"); und und Konsole Konsole löschen löschen line line buffer.readline(); buffer.readline(); nächste nächste Zeile Zeile lesen lesen PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 21

22 Beispiel 2 (Auszug) static static void void more(string more(string filename) filename) throws throws FileNotFoundException, FileNotFoundException, IOException IOException FileInputStream FileInputStream stream stream FileInputStream(fileName); FileInputStream(fileName); InputStreamReader InputStreamReader reader reader InputStreamReader(stream); InputStreamReader(stream); BufferedReader BufferedReader buffer buffer BufferedReader(reader); BufferedReader(reader); InputStreamReader InputStreamReader console console InputStreamReader(System.in); InputStreamReader(System.in); System.out.print("\f"); System.out.print("\f"); Konsole Konsole löschen löschen String String line line buffer.readline(); buffer.readline(); erste erste Zeile Zeile stream stream lesen lesen int int count count 1; 1; FileInputStream FileInputStream while(line while(line!! null) null) solange solange noch noch Zeilen Zeilen da da System.out.println(count System.out.println(count + + ":\t" ":\t" + + line); line); ausgeben reader ausgeben reader if(++count if(++count % % ) 1) alle alle InputStreamReader Zeilen InputStreamReader Zeilen console.read(); console.read(); auf auf Eingabe Eingabe warten warten System.out.print("\f"); System.out.print("\f"); und und Konsole buffer Konsole buffer löschen löschen BufferedReader BufferedReader line line buffer.readline(); buffer.readline(); nächste nächste Zeile Zeile lesen lesen line line String String PI-1: Prozeduren, Funktionen, Datenströme, JavaDoc 22