Développons en Java avec Eclipse

L'aide en ligne est disponible dans toute l'interface de l'IDE au moyen de la touche F1. Cette aide est contextuelle en fonction de l'élément sélectionné dans l'interface au moment de l'appui sur la touche.

Le choix des sujets se rapportant à l'élément courant est affiché dans une info bulle. Il suffit de cliquer sur l'élément sélectionné pour que l'aide en ligne correspondante s'affiche.

exemple avec l'appui sur F1 dans l'éditeur de code java

L'aide Javadoc

Si la configuration de l'IDE est correcte il est possible d'accéder directement à la page javadoc d'un élément java en plaçant le curseur sur cet élément et en appuyant sur F2.

Si l'accès à la documentation javadoc pour l'élément n'est pas configuré un message d'erreur s'affiche.

Pour configurer l'IDE, il faut sélectionner la ressource qui contient l'élément dans la vue "Packages" :

Exemple : associer la doc du JDK avec le fichier rt.jar

Sélectionner le fichier rt.jar dans un projet de la vue "Packages" et sélectionner le menu contextuel "Propriétés".

Il faut sélectionner "Emplacement Javadoc" puis cliquer sur parcourir pour sélectionner le répertoire qui contient le fichier package-list de la documentation.

Il faut cliquer sur "OK" pour valider les changements.

Si le chemin n'est pas correct, un message d'erreur est affiché.

Il est alors possible dans l'éditeur de code Java de positionner le curseur sur un élément contenu dans un des emplacements Javadoc pour que l'aide en ligne affiche la page concernée par l'élément dans la documentation javadoc.

Ce processus est applicable à toutes les API dont la documentation Javadoc est disponible.

La société Crionics propose un plug in qui s'intègre dans l'aide en ligne de Eclipse et qui contient la documentation du JDK 1.3 et de quelques API open source.

Ce plug in créée une entrée nommée "Essentials Java Docs" dans la table des matière de l'aide en ligne. Cette documentation regroupe les API essentiels.

Ce plug in est téléchargeable sur le site de Crionics (environ 30 Mo): http://www.crionics.com/products/opensource/eclipse/com.crionics.java.doc.zip

Pour l'installer, il suffit de dézipper son contenu dans le répertoire plug in d'intallation d'Eclipse.