/**
et */
) qui permettent la génération automatique d'une
documentation HTML avec la commande javadoc du Java
Development Kit. Voici l'exemple de la documentation d'une méthode
d'une interface ; le commentaire précède la déclaration de la méthode,
comporte des mots-clés spécifiques (@param, @returns)
et des balises HTML (<tt>...</tt>) :
/** * Returns <tt>true</tt> if this collection contains * the specified element. More formally, returns * <tt>true</tt> if and only if this collection contains * at least one element <tt>e</tt> such that * <tt>(o==null ? e==null : o.equals(e))</tt>. * * @param o element whose presence in this collection * is to be tested. * @return <tt>true</tt> if this collection contains the * specified element */ boolean contains(Object o);
En outre, la distinction public/privé permet une discipline de noms : les noms privés, n'étant pas connus à l'extérieur de leur paquet, peuvent être réutilisés sans risque par d'autres paquets.