Hallo,
ich sitze hier an einer Hausarbeit, wo ich meinen Quellcode beschreiben soll. Ich bin mir nicht sicher, wie ich die Klassenbeschreibungen aufbauen soll, der Prof gab auch keine anweisung
wie sieht folgendes aus:
klassenname
- ganz kurze beschreibung, was damit gemacht wird
- uml darstellung mit attributen und Methoden und evtl. inneren Klassen
Bereitgestellte Dienste:
- benötigten Methoden der anderen Klassen: nennung und ein satz wozu
Attribute:
- nennung und ein satz wozu
Methoden:
- nennung und ausführlich
wie habt ihr das bisher gemacht???
steffi
Genau so 
Du hast schon den richtigen Ansatz. Beispiel UML-Klassendiagramme mit Vererbung gibt’s im Web tonnenweise. Ich benutze noch UML Version 1.4, obwohl 2.0 mittlerweile draussen ist.
www.oose.de/uml hat gute UML-Unterlagen…
Genau so
hm, na dann bin ich ja auf der richtigen Spur.
Ist es sinnvoll, bei den Methoden die gesamte Signatur zu schreiben, oder nur auszugsweise. gesamte könnte teilweise bis 3 Zeilen werden (durch schriftart und geeignete Umbrüche)
zb.
public static void main(String[] argv)
oder so:
main(String[])
PS: die Becher sind ja klasse: http://www.oose.de/uml-becher.htm
Du hast schon den richtigen Ansatz. Beispiel
UML-Klassendiagramme mit Vererbung gibt’s im Web tonnenweise.
Ich benutze noch UML Version 1.4, obwohl 2.0 mittlerweile
draussen ist.
www.oose.de/uml hat gute UML-Unterlagen…
Ob du Parameter und Rückgabewerte schreiben oder weglassen willst, ist natürlich ziemlich subjektiv. In deinem fall, wo du scheinbar sehr grosse Signaturen hast, würde ich mich der Übersichtlichkeit wegen auf die Namen beschränken…
JavaDoc?
Hi -
UML ist zwar sehr nett und erlaubt dir sehr viel - Die Frage ist, ob sich der Aufwand für eine Hausarbeit lohnt Warum schreibst du das nicht mit Javadoc? Auch auf die Gefahr hin, dir was zu erklären, was du schon kennst: Einfach im Quellcode nach folgendem Schema kommentieren:
**/\*\*
\* Autor: J.P.Jarolim
\* Date: 17.02.2005
\* Time: 16:39:14
\* Allgemeine Beschreibung der Klasse
\* Eventuelle Beispiele für Benutzung
\*/**
import java.io.IOException;
public class MySuperTolleClass {
**/\*\* Beschreibung der Variable \*/**
private String tolleVariable = null;
**/\*\*
\* Beschreibung der Methode
\* @return Beschreibung des Rückgabewertes
\* @throws IOException Beschreibung der Fälle, in denen die IOException geworfen wird
\*/**
public String getTolleVariable()
throws IOException {
if (tolleVariable != null) {
return tolleVariable;
} else {
throw new IOException("nix drin");
}
}
**/\*\*
\* Beschreibung der Methode
\* @param tolleVariable Beschreibung des anzugebenden Parameters
\*/**
public void setTolleVariable(String tolleVariable) {
this.tolleVariable = tolleVariable;
}
}
Danach einfach javadoc drüberlaufen lassen und die entstandenen HTML-Seiten auf Diskette oder ausgedruckt abgeben. Das ganze hat den Vorteil, dass du die Dokumentation während dem Schreiben des Codes erstellen kannst - Also genau dann, wenn du noch verstehst, was du da überhaupt gemacht hast
Ein bisserl mehr Info: http://java.sun.com/j2se/javadoc/
mfG,
J.P.Jarolim
die Aufgabenstellung beinhaltet das. Da reicht javadoc leider nicht.
steffi
Hi -
UML ist zwar sehr nett und erlaubt dir sehr viel - Die Frage
ist, ob sich der Aufwand für eine Hausarbeit lohnt Warum
schreibst du das nicht mit Javadoc? Auch auf die Gefahr hin,
dir was zu erklären, was du schon kennst: Einfach im Quellcode
nach folgendem Schema kommentieren: