Test og Dokumentation - slide 40 : 46

Introduktion til javadoc 

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