« Java/Annexe/Documenter un programme » : différence entre les versions

Contenu supprimé Contenu ajouté
Aucun résumé des modifications
Ligne 132 :
== Générer la documentation ==
 
Pour générer la documentation, tapez « javadoc MonProgramme.java ». Remplacez bien sûr « MonProgramme » par le nom de votre programme.

Par défaut, javadoc ne génére pas la documentation pour les commentaires au-dessus d'une méthode ou d'un champ possédant le modificateur « private ».
Ce qui est logique pour une documentation destinée à ceux qui vont utiliser les classes de manière externe, sans accès aux membres privés depuis leur propres classes.
 
Cependant, la documentation des membres privés peut être utile aux développeur des classes concernées.
De même, les développeurs qui utilisent les classes d'un package depuis leurs propres packages n'ont pas besoin de la documentation des membres protégés.
La commande <code>javadoc</code> possède donc des options pour le niveau de documentation voulu :
* <code>-public</code> : ne documenter que les membres publics.
* <code>-protected</code> : ne documenter que les membres publics et protégés.
* <code>-package</code> : ne documenter que les membres publics, protégés et package (sans mot-clé).
* <code>-private</code> : documenter tous les membres (publics, protégés, package, privés).
 
{{Bas de page