Javadoc is een tool waarmee je documentatie kan aanmaken in HTML-formaat. Deze documentatie is gebaseerd op wat je als commentaar voorziet in de broncode.
Een lijncommentaar begint met een dubbele schuine streep (//).
Wil je commentaar over meer regels kwijt, dan begin je met /* en je eindigt met */
Javadoc begint steevast met /** ; een sterretje extra dus.
Je kan verschillende zaken kwijt in Javadoc zoals @author, @version.
Eclipse biedt je de mogelijkheid om vanuit je IDE de javadoc-webpagina's te genereren.
Kies daarvoor project - generate javadoc
In het volgende scherm krijg je de mogelijkheid om aan te geven voor welke Javaprojecten je de documentatie
wil aanmaken. Maar merk op dat je in het scherm hieronder een foutmelding ziet : Eclipse weet immers nog niet waar
het commando Javadoc is geïnstalleerd.
Je kan via de browseknop door de harde schijf bladeren. Zoek de folder op waar je de Java Software Development Kit (ofte JDK) hebt geïnstalleerd. Daaronder vind je nog een binmap en doorgaans kan je daar Javadoc vinden.
Je kiest best voor de standaard doclet. Zo krijgt je documentatie dezelfde opmaak als die van de standaard Javadocumentatie.
Je kan nog een map kiezen waar je de HTML-pagina's wil bewaren.
Na de generatie van de HTML-pagina's kan je de documentatie doorbladeren. Het startpunt is zoals je kon verwachten de index.html pagina.
