Page 40 : 46

Forelæsningsnoter i Objekt-orienteret Programmering Test og Dokumentation * Introduktion til programtest Introduktion til test Testabilitet Testenheder Testutopi Programbevis * White box testteknik White box test Test af uafhængige stier Fra programenhed til flow graph (1) Fra programenhed til flow graph (2) Udledning af testtilfælde til white box test Andre white box tests * Black box testteknik Black box test Valg af input til black box test (1) Valg af input til black box test (2) Eksempel på black box test * Teststrategi Teststrategi Enhedstest Integrationstest Sammenligning af top-down og bottom-up integrationstest * Code Review Code Review * Test af objekt-orienterede programmer Observationer Test af klasse 'skiver' Detaljer om slice-baseret klasse enhedstest Klassen som testenhed: Praktiske problemer Test i forhold til kontraktideen (1) Test i forhold til kontraktideen (2) Opsummering * Introduktion til programdokumentation Hvorfor programdokumentation Moduldokumentation Dokumentation: Strukturering i tid og rum Dokumentation i forhold til test * Javadoc Introduktion til javadoc Javadoc materiale * Literate Programming Intern programdokumentation ala literate programming Det klassiske literate programming værktøj Intern struktur af et literate WEB dokument Opsummering

Introduktion til javadoc

Javadoc er et eksempel på et simpelt værktøj, som kan gøre stor nytte når vi skal definere eksternt rettet moduldokumentation af et objekt-orienteret programmet

Javadoc er baseret på ideen om at udtrække moduldokumentation fra et eksisterende program

Karakteristik af javadoc: Dokumentationen bor i klassen Dokumentation udtrækkes fra særlige doc comments i klassen, som 'parses' til en hvis grad Doc comments er særligt mærkede kommentarer: /** ... */ Det er muligt at bruge HTML tags i dokumentationen med henblik på formatering Undlade at bruge tags (header tags) som interfererer med formateringen af de overordnede dele af et javadoc dokument Billeder kan inkluderes via HTML tag'et img Ikoner, som bruges af javadoc, skal findes i dokumentationskatalogets 'images directory' Understøtter særlige, javadoc specifikke tags Til beskrivelse af forfatter, version, parametre til metoder, returværdi af metoder, forældelse, oprindelsesversion, undtagelser, serialisering, og krydsreferencer