Test og Dokumentation
- slide 36 : 46
Moduldokumentation
I objekt-orienteret programmering udgøres moduldokumentation af en beskrivelse af klassernes klientgrænseflader
Hvilke aspekter af en klasse skal dokumenteres?
En forklaring af klassens sammenhæng med andre klasses, og evt. overordnede forhold omkring klassen
Klassenavn, superklasse og klasseinvariant
Intuitiv og eksternt rettet forklaring af klassen
Signaturen af metoder: navn, parametertyper, rækkefølgen af parametrene, typen af returværdien, exceptions, pre- og postbetingelser
Intuitiv og eksternt rettet forklaring pr. metode