Die readFile.class und Kommentierung mit Javadoc

readFile.class
Javadoc
Die readFile.class und Kommentierung
mit Javadoc
Dennis Groh und Martin Rippel
February 6, 2009
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
1
readFile.class
Überblick
Quelltext en détail
2
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
1
Überblick
Quelltext en détail
readFile.class
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Überblick
Zum Auslesen eines Char-Arrays aus einer Datei
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Überblick
Zum Auslesen eines Char-Arrays aus einer Datei
1
Übergeben eines Dateinamens als Parameter
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Überblick
Zum Auslesen eines Char-Arrays aus einer Datei
1
2
Übergeben eines Dateinamens als Parameter
Auslesen der Daten
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Überblick
Zum Auslesen eines Char-Arrays aus einer Datei
1
2
3
Übergeben eines Dateinamens als Parameter
Auslesen der Daten
Schreiben in ein leeres erzeugtes Feld
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Überblick
Zum Auslesen eines Char-Arrays aus einer Datei
1
2
3
4
Übergeben eines Dateinamens als Parameter
Auslesen der Daten
Schreiben in ein leeres erzeugtes Feld
Rückgabe des Feldes
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
Versuche...
...Datei in Speicher zu lesen...
...von dort in’s Feld...
...und schließe den Speicher
Fange Fehlermeldung ab...
...und melde Fehler
Gib das Feld zurück
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
try
{
in = new BufferedReader(new FileReader(filename));
in.read(valueArray);
in.close();
}
catch(IOException fehler)
{
System.out.println("Fehler beim Input/Output!");
}
return valueArray;
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
public static char[] toChar(String filename)
{
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
public static char[] toChar(String filename)
{
File file = new File(filename);
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
public static char[] toChar(String filename)
{
File file = new File(filename);
Bestimmen der Größe der Datei
int filesize = (int)file.length();
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
public static char[] toChar(String filename)
{
File file = new File(filename);
Bestimmen der Größe der Datei
Erzeugen eines Feldes
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
Versuche...
try
{
}
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
Versuche...
try
{
}
Fange Fehlermeldung ab...
catch(IOException fehler)
{
}
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
Versuche...
try
{
in = new BufferedReader(new FileReader(filename));
...Datei in Speicher zu lesen...
}
Fange Fehlermeldung ab...
catch(IOException fehler)
{
}
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
Versuche...
try
{
in = new BufferedReader(new FileReader(filename));
in.read(valueArray);
in.close();
}
...Datei in Speicher zu lesen...
...von dort in’s Feld...
...und schließe den Speicher
Fange Fehlermeldung ab...
catch(IOException fehler)
{
}
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
Versuche...
try
{
in = new BufferedReader(new FileReader(filename));
in.read(valueArray);
in.close();
}
...Datei in Speicher zu lesen...
...von dort in’s Feld...
...und schließe den Speicher
Fange Fehlermeldung ab...
catch(IOException fehler)
{
System.out.println("Fehler beim Input/Output!");
}
...und melde Fehler
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Überblick
Quelltext en détail
Quelltext en détail
Deklaration der Methode
Variable als Zeiger auf Datei
Variable für Zwischenspeicher
Bestimmen der Größe der Datei
Erzeugen eines Feldes
Versuche...
...Datei in Speicher zu lesen...
...von dort in’s Feld...
...und schließe den Speicher
Fange Fehlermeldung ab...
...und melde Fehler
Gib das Feld zurück
public static char[] toChar(String filename)
{
File file = new File(filename);
BufferedReader in;
int filesize = (int)file.length();
char[] valueArray = new char[filesize];
try
{
in = new BufferedReader(new FileReader(filename));
in.read(valueArray);
in.close();
}
catch(IOException fehler)
{
System.out.println("Fehler beim Input/Output!");
}
return valueArray;
}
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
2
Grundlagen
Tags
Beispiel
Kompilierung
Javadoc
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Vorteil: leichteres Navigieren in der Dokumentation
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Dennis Groh und Martin Rippel
Grundlagen
Tags
Beispiel
Kompilierung
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Vorteil: leichteres Navigieren in der Dokumentation
Syntaktische Grundlagen
Javadoc-Kommentierungen innerhalb /∗∗ und ∗ /
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Vorteil: leichteres Navigieren in der Dokumentation
Syntaktische Grundlagen
Javadoc-Kommentierungen innerhalb /∗∗ und ∗ /
direkt vor zu kommentierendem Item
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Vorteil: leichteres Navigieren in der Dokumentation
Syntaktische Grundlagen
Javadoc-Kommentierungen innerhalb /∗∗ und ∗ /
direkt vor zu kommentierendem Item
Nutzung von HTML-Tags
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Allgemeines
Dokumentationen aus Java-Quelltexten im HTML-Format
HTML-Seite muster.html aus Datei muster.java
zusätzlich verschiedene Index- und Hilfsdateien
Vorteil: leichteres Navigieren in der Dokumentation
Syntaktische Grundlagen
Javadoc-Kommentierungen innerhalb /∗∗ und ∗ /
direkt vor zu kommentierendem Item
Nutzung von HTML-Tags
Nutzung spezieller Javadoc-Tags
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Einige HTML-Tags
zur Formatierung der Dokumentation möglich
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Einige HTML-Tags
zur Formatierung der Dokumentation möglich
<b> ... </b>
<u> ... </u>
<br>
...
bold
unterstrichen
Zeilenumbruch (break row)
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Einige HTML-Tags
zur Formatierung der Dokumentation möglich
<b> ... </b>
<u> ... </u>
<br>
...
bold
unterstrichen
Zeilenumbruch (break row)
Wichtige Javadoc-Tags
Gliederung der Dokumentation in einzelne Abschnitte
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Einige HTML-Tags
zur Formatierung der Dokumentation möglich
<b> ... </b>
<u> ... </u>
<br>
...
bold
unterstrichen
Zeilenumbruch (break row)
Wichtige Javadoc-Tags
Gliederung der Dokumentation in einzelne Abschnitte
@author
@version
@param
@return
@throws
Autoreneintrag
Versionseintrag
Beschreibung der Parameter
Rückgabewert
Angabe der Exceptions
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Beispiel
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Beispiel
/**
* Die Klasse <b> readFile </b> (Read from File)
* stellt mehrere Methoden bereit, um aus Dateien
* oder anderen Ressourcen Wertefelder einzulesen.
* <br><br>
* Die Klasse erfordert <b>Java 5</b>.
@version 23.01.2009
@author D. Groh, M. Rippel
*/
public class readFile
.
.
.
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Kompilierung
per Befehl javadoc [options][sourcefiles]
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Kompilierung
per Befehl javadoc [options][sourcefiles]
sourcefiles:
Quelldatei
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Kompilierung
per Befehl javadoc [options][sourcefiles]
sourcefiles: Quelldatei
Wichtige Optionen:
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Kompilierung
per Befehl javadoc [options][sourcefiles]
sourcefiles: Quelldatei
Wichtige Optionen:
-private
-public
-d
-author
-version
Dokumentation aller Klassen
nur Dokumentation von public-Klassen
Zielverzeichnis (directory)
Erzeugung Autoreneintrag
Erzeugung Versionseintrag
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc
readFile.class
Javadoc
Grundlagen
Tags
Beispiel
Kompilierung
Weiterführende Websiten
http://de.selfhtml.org
http://homepages.fh-giessen.de/
hg7132/PIS/Uebungen/javadoc tutorial.html
Dennis Groh und Martin Rippel
Die readFile.class und Kommentierung mit Javadoc