Lecture overview -- Keyboard shortcut: 'u'  Previous page: Hvorfor programdokumentation -- Keyboard shortcut: 'p'  Next page: Dokumentation: Strukturering i tid og rum -- Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 36 : 46
Forelæsningsnoter i Objekt-orienteret Programmering
Test og Dokumentation
Moduldokumentation

Moduldokumentation er på helt naturlig måde dokumentation af klasser når vi taler objekt-orienteret programmering

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