Discussion :

[vinsent]

Bonjour,

J'utilise NetBeans 6.9 pour mac et je voudrais réaliser ma javadoc avec l'éditeur. Je n'ai pas de problèmes pour la doc concernant les méthodes ou les classes.

Cependant, NetBeans ne semble pas prendre en compte les commentaires sur les variables de classe : ils ne me sont pas proposés et ils n'apparaissent pas dans les fichiers html une fois la javadoc compilée (à part pour les constantes déclarées final).

Par exemple, le code ci-dessus n'a aucun effet sur la javadoc:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
public class Exemple{
 
   /**
    * Identifiant de l'exemple.
    *
    */
    private int ID;
 
...
}

Quelqu'un a dèjà remarqué cela? Ou quelqu'un a-t-il une solution? Merci d'avance!!!

[le y@m's]

Bonjour,

Par défaut la javadoc des membres avec les visibilités private et package n'est pas générée.
Pour l'inclure va dans les propriétés de ton projet. (clic droit Properties), sélectionne le noeud Documenting (noeud fils de Build) et coche la checkbox "Include Private and Package Private Members" .

[vinsent]

Merci beaucoup!

Du coup, je me pose une question. Cela veut-il dire que la tradition javadoc est de ne pas inclure les champs privés? Ou est-ce que cela dépend uniquement de leur pertinence?

[le y@m's]

Les champs privés/package sont invisibles par les utilisateurs donc généralement, si la javadoc est à leur destination alors il est inutile de les inclure, cela ne ferait que l'alourdir inutilement.
En revanche ces champs sont intéressant pour les développeurs (notamment s'il y a plusieurs développeurs, ou pour de la maintenance).

Donc en général on génère deux versions de la javadoc. Une version sans les membres private/package qui sera à destination des utilisateurs, et une version avec tous les membres qui sera à destination des développeurs.