Cours Javadoc outil fourni par Sun avec le JDK

Cours Javadoc outil fourni par Sun avec le JDK, tutoriel & guide de travaux pratiques en pdf.

Le tag {@literal}

Ce tag permet d’afficher un texte qui ne sera pas interprété comme de l’HTML.
La syntaxe de ce tag est la suivante :
{@literal texte}
Le contenu du texte est repris intégralement sans interprétation. Notamment les caractères < et > ne sont pas interprétés comme des tags HTML.
Pour afficher du code, il est préférable d’utiliser le tag {@code}
Exemple :
{@literal 0<b>10}

Le tag {@linkplain}

Ce tag permet de créer un lien vers un autre élément de la documentation dans une police normale.
Ce tag est similaire au tag @link. La différence réside dans la police d’affichage.

Le tag {@inheritDoc}

Ce tag permet de demander explicitement la recopie de la documentation de l’entité de la classe mère la plus proche correspondante.
La syntaxe de ce tag est la suivante:
{@inheritDoc}
Ce tag permet d’éviter le copier/coller de la documentation d’une entité.
Il peut être utilisé :
dans la description d’une entité : dans ce cas tout le commentaire de l’entité de la classe mère est repris dans un tag @return, @tag, @throws : dans ce cas tout le texte du tag de l’entité de la classe mère est repris

Le tag {@docRoot}

Ce tag représente le chemin relatif à la documentation générée.
La syntaxe de ce tag est la suivante :
{@docRoot}
Ce tag est pratique pour permettre l’inclusion de fichiers dans la documentation.
Exemple :
<a href= »{@docRoot}/historique.htm »>Historique</a>

…….