De Javadoc-tool

Om de commentaar om te zetten in HTML-formaat, beschikt de JDK over de tool Javadoc. Dit programma beschikt over een uitgebreid gamma commandolijnparameters waarvan we in het volgende tabel de belangrijkste opsommen.

Parameter/argumentBeschrijving
-authorDe vermelding van de auteur (@author) wordt opgenomen in de documentatie.
-classpath path-listDe paden waar de tool naar andere klassen zoekt.
-d pathHet pad waar de uiteindelijke documentatie gegenereerd word.
(destination)
-versionDe vermelding van de versie (@version) wordt opgenomen in de documentatie.
-sourcepath pathHet pad waar de broncode zich bevindt.
-overview pathHet pad waar de html staat die de overzichtspagina zal worden.

Voor een volledige beschrijving van alle mogelijkheden verwijzen we naar de JDK-documentatie.

In ons voorbeeld kunnen we de documentatie van de klassen van het pakket be.multimedi.plantcare als volgt genereren (volgende commando is 1 lijn zonder enter toetsen):

javadoc -author -version -d docs -sourcepath src be.multimedi.plantCare.consoleApp be.multimedi.plantCare.model be.multimedi.plantCare.model.plant

In IntelliJ en andere IDE’s kan men de documentatie ook laten generen door de IDE, welke op zijn beurt dan de Javadoc-tool gebruikt.

In IntelliJ ga je naar het menu “Tools” en klik je op “Generate JavaDoc…”.

Opdracht: Documentatie genereren

  • Voorzie alle klassen en interfaces van een project van de nodige documentatie. Begin hierbij met de klassen in de top van de hiërarchie.
  • Genereer de documentatie met de Javadoc-tool of IDE