Tutoriel Java N°4 : documentation Javadoc
Générez une documentation de vos programmes java avec l’outil javadoc.exe, présent dans le répertoire ’bin’ de votre kit de développement java (JDK). Intégrez javadoc à eclipse. Automatisez la génération de la documentation avec un fichier ant (javadoc.xml) .
Après avoir compris la génération de documentation d’un programme, vous découvrirez comment créer un livrable à votre client avec l’outil jar.
Prérequis
Tutoriel Java N°3 : installation Eclipse et premier projet
Objectifs
Comprendre le programme javadoc (JDK)
Comprendre l’intégration de Javadoc dans Eclipse
Automatiser la génération de la javadoc
Programme
Partie 1 : Commentaires Javadoc dans code source java
Partie 2 : Assistant eclipse de génération Javadoc
Partie 3 : Automatisation de la génération javadoc (javadoc.xml)
Conclusion
Inscrivez-vous à la prochaine formation JAVA Objis
Pensez à votre carrière !
Durée
20 min
Qui sommes-nous ?
Partie 1 : commentaires javadoc
Le tutoriel JAVA n°3 ’Installation eclipse’ vous a permis de vous familiariser avec l’environnement de développement eclipse. En particulier, vous avez exécuté dans eclipse votre premier programme java.
Modifiez le programme ci-dessus de la façon suivante.
— Quelles sont les modifications apportées ?
— Expliquez le commentaire javadoc associé à la classe, ainsi que le commentaire javadoc associé à la méthode main().
— Analysez l’impact du raccourci clavier suivant : Alt+Shift+J
— Montrez que ce raccourci est précisé dans la liste des raccourcis Eclispe : Ctrl+Shift+L
Partie 2 : Génération Javadoc
Dans cette partie vous allez utiliser un assistant de création de la document javadoc de l’application.
Sélectionnez le projet en cours et faire menu "Project/Generate javadoc"
L’écran suivant apparaît.
Sélectionnez la visibilité ’private’ afin de créer la documentation de toutes les classes de l’application.
REMARQUE le répertoire par défaut ’doc’ de destination des fichiers HTML de javadoc.
Cliquez sur le bouton ’Next’. L’écran suivant apparaît
QUESTION : à quoi servent les tags javadoc @author , @version et @deprecated ?
Sélectionnez la librairie rt.jar qui représente l’API principale de Java. Cela permet de créer un lien vers les classes de cette API qui sont utilisées dans le projet.
Cliquez sur le bouton ’Next’. L’écran suivant apparaît
Cocher l’opton ’Save the settiings of this javadoc export as an Ant script’. Cela permet d’enregistrer la configuration de génération javadoc dans un script ant.
Pour regénérer la javadoc ultérieurement, il suffira d’exécuter le script (click droit sur le script javadoc.xml / Run / Ant Build)
Cocher la case ’Open generated index file in browser’ pour visualiser la documentation générée.
Cliquez sur le bouton ’Finish’.
L’écran suivant apparaît.
Validez (Bouton YES) ce message,qui informant de la création du répertoire doc.
Le message suivant apparait, informant de la création du fichier ANT javadoc.xml, clé de l’automatisation des futures javadoc
Cliquez sur OK
le répertoire ’doc’ et le fichier javadoc.xml apparaissent dans le worskpace.
REMARQUE : vous n’avez pas besoin ici de comprendre le contenu du fichier javadoc.xml. Pour une compréhension de ANT, découvrez nos tutoriaux ANT.
Click droit / Refresh sur le répertoire ’doc’
voir le contenu du répertoire doc
La javadoc du projet apparaît.
- tutoriel-java-javadoc-11
Double-click sur fichier ’index.html’
- tutoriel-java-javadoc-12
Cliquer sur le lien de la classe ’HelloObjis’
- tutoriel-java-javadoc-13
Partie 3 : automatiser la génération
Modifier le commentaire de la classe
- utilisation CTRL Espace pour choisir tag javadoc
Utiliser la combinaison de touches CTRL + ESPACE pour découvrir les balises javadocs que vous pouvez utiliser.
click droit sur le script javadoc.xml / Run / Ant Build
- tutoriel-java-javadoc-16
Le script de génération de la javadoc se lance :
La javadoc est régénérée avec nos options.
- tutoriel-java-javadoc-17
Notre modification de commentaire avec la version a été prise en compte.
Conclusion
Ce tutoriel vous a permis de vous familiariser avec la création de documentation de code source java avec l’outil javadoc.exe et l’environnement de développement eclipse.
Le tutoriel suivant ’Tutoriel JAVA N°5 : création d’archives JAR’ permettra de vous familiariser avec la création d’archives JAR dans l’environnement de développement eclipse.
Prochaine formation JAVA
Le chemin le plus court pour avoir les réflexes et la méthodologie du bon développeur Java :
Repartez de la formation avec votre clé USB 4GO spéciale ’formation JAVA Objis’ et comportant cours, outils et corrigés Travaux pratiques !
- cle-usb-objis-formation-java
Pensez à votre carrière !
Rejoignez le réseau objis.com
Visiteurs objis.com : vous appréciez notre sens du partage ? Rejoignez notre réseau !
