Tutoriel JAVA N°4 : intégration de la Javadoc JSE dans Eclipse

Liez Eclipse avec la Javadoc JSE, afin de pouvoir obtenir facilement les informations Javadoc d’une classe ou d’une interface sans avoir à quitter Eclipse.

Aprés avoir compris l’intégration de la Javadoc JSE dans Eclipse , vous découvrirez les bonnes pratiques de développement avec Eclipse

ASTUCE —> Soyez informé de la mise à jour de nos tutos ou de la création de nouveaux tutos.

Prérequis

- Tutoriel Java N°3 : téléchargement et installation Eclipse

Objectifs

- Comprendre l’intégration de Javadoc dans Eclipse

Programme

- Partie 1 : Téléchargement de la Javadoc
- Partie 2 : Utilisation Javadoc de la machine locale
- Partie 3 : Test de la Javadoc locale
- Conclusion

Durée

- 20 min

Partie 1 : Téléchargement de la Javadoc

- Rendez vous sur le site d’Oracle à cette adresse

Cochez ’Accept Licence Agreement’ et cliquez sur le lien "jdk-8u20-docs-all.zip" pour le télécharger

PNG - 23.3 ko
download-doc-java8

Téléchargez la documentation sur le répertoire ’doc’ que vous aurez créé sous le répertoire outils : C :\formationjava\outils\doc

PNG - 13.2 ko
download-doc-java8-1
PNG - 8.2 ko
download-doc-java8-2

Partie 2 : Utilisation Javadoc de la machine locale

- A partir d’Eclipse , allez sur Window / Preferences

PNG - 13.9 ko
Eclipse-window-preference

- Puis sélectionnez Java / Installed JREs

PNG - 26.6 ko
Eclipse-installed-jre

Cliquez sur le bouton Edit , l’écran suivant apparait

PNG - 29.2 ko
Eclipse-installed-jre-1

- Sélectionner TOUS les Jars puis cliquez sur le bouton ’Javadoc Location’

PNG - 33.3 ko
Eclipse-installed-jre-2

L’écran suivant apparaît :

PNG - 16.6 ko
Eclipse-installed-jre-3

Explication

C’est le chemin par défaut sur Eclipse pour bénéficier de la Javadoc en ligne , il nécessite un accés à internet .

Maintenant nous allons spécifier à Eclipse que la Javadoc se trouve dans le fichier jdk-8u20-docs-all.zip ; et que la page index.html se trouve dans le sous répertoire docs/api du zip .

- Cliquez sur le bouton radio ’Javadoc in archive’.

L’écran suivant apparaît :

PNG - 17.3 ko
Eclipse-installed-jre-4

A l’aide du bouton ’Browse’ localisez le chemin du fichier jdk-8u20-docs-all.zip

- Collez le chemin d’accés du répertoire C :\formationjava\outils\doc , vous obtenez l’écran

PNG - 27.2 ko
eclipse-download-4

Sélectionnez le fichier ’jdk-8u20-docs-all.zip’ et cliquez sur le bouton ’Valider’ , l’écran suivant apparaît :

PNG - 18.3 ko
eclipse-download-5

Ajouter docs/api dans le champ ’Path within archive :’

PNG - 18.7 ko
eclipse-download-6

Cliquez sur le bouton ’OK’ , l’écran suivant apparait :

PNG - 31.4 ko
eclipse-download-9

Validez en cliquant sur ’Finish’

PNG - 25.3 ko
eclipse-download-10

Puis sur le bouton ’Ok’

Partie 3 :Test de l’intégration de la Javadoc :

- Ouvrez le fichier HelloObjis.java du projet ’GestionFormations’

Faites passer le curseur au dessus d’une méthode de la classe (ici println) , une bulle sort pour donner les informations de la méthode

PNG - 35.9 ko
eclipse-download-8

Ca y est , vous pourrez accéder à la javadoc directement en pointant le curseur de la souris sur une classe de votre code

Conclusion

Dans ce tutoriel java N°4, vous avez intégré la documentation Javadoc dans Eclipse. Vous augmentez ainsi votre productivité .

Dans le tutoriel Java N°5 ’Bonnes pratiques de développement avec Eclipse’ vous allez apprendre quelques bonnes pratiques de développements dans l’environnement Eclipse

Votre avis nous intéresse

Vous avez remarqué une erreur ? Vous avez une recommandation pour améliorer ce tuto ? Vous souhaitez nous encourager à partager notre savoir-faire technique et pédagogique ?

Donner votre avis sur ce Tuto objis.com