Geheimnisprinzip / Dokumentation mit Javadoc

Geheimnisprinzip

Beispiel: Datum

Version 2: Alternative Implementierung der Klasse Date. Intern wird das Datum durch eine Zeichenkette repräsentiert. Beachte: Die Klasse hat die gleichen Schnittstellen wie Version 1, drum kann sie exakt gleich verwendet werden!

Dokumentation mit Javadoc

Beispiel: Datum

Schnittstellendokumentation

Dokumentiert das WAS: Alle Informationen zur Benutzung der Klasse:

Klassendokumentation

wofür ist die Klasse, welches ist die grundlegende Idee dazu, Hintergrundinformationen zum Verstehen ihres Zwecks und ihrer Funktionsweise

Methodendokumentation (für non-private Methoden)

allgemein: was macht die Methode, konkret: Parameter erläutern, erlaubte Werte, Rückgabewert erläutern, mögliche Werte, Ausnahmen erläutern

Attributdokumentation (für non-private Attribute)

allgemein: was repräsentiert das Attribut, welche Werte darf es haben; beachte: Attribute sollten gewöhnlich private sein; Ausnahme: Konstanten sind oft public

Implementierungskommentare

Dokumentiert das WIE: Erläuterungen zu Implementierungsdetails, einzelnen Anweisungen; zum Verständnis der Klasseninterna; auch:

Methodendokumentation (für private Methoden)

genauso wie oben für non-private; aber: nicht für das Verständnis von Klassenbenutzern gedacht, sondern für Leute, die die Interna warten/verändern

Attibutdokumenation (für private Attribute)

<entsprechend>

Version 2 (inkl. Doku): obige Klasse mit vollständiger Dokumentation. Beachte: Die Schnittstellendokumentation ist identisch zu Version 1; nur die Implementierungskommentare sind unterschiedlich!