Discussion :

[ruda.tom]

Bonjour,

Je développe une bibliotheque d'outils "useful_tools.jar" qui regroupe un ensemble de classes utilitaires.

Lorsque je récupère mon "useful_tools.jar" dans un projet et que j'utilise une de ces classes utilitaires, je n'ai pas la description des champs à passer, mais j'ai simplement leur type ...

Et des méthodes "useful_fonction_1(String arg1, String arg2)" c'est pas top pour le développeur qui utilise la bibliothèque derrière ...

J'ai pourtant décrit mes méthodes avec des @param, @return, ... mais visiblement cela ne fonctionne pas ...

Merci pour votre aide

Ci joint un exemple de méthode que j'ai décrite :

/**
* Permet d'exécuter une requête de recherche
*
* @param principal Utilisateur
* @param queryText Requete à exécuter
* @param resultCount Nb résultats
* @param startRow Occurence de début
* @param sortOrder Ordre de tri
* @param sortField Sur quel champ trié
* @return ResultsSet
*/

[ruda.tom]

Personne n'a donc de réponse à me donner pour mon problème ?!

[adiGuba]

Salut,

Personne n'a donc de réponse à me donner pour mon problème ?!

En même temps on ne peux pas dire que tu sois très précis !
qu'est-ce qui ne marche pas ? La génération de la javadoc ? Si oui pourquoi posté dans le forum Servlet/JSP...

Sinon précises un peu plus ton problème...

a++

[ruda.tom]

Je suis désolé si je n'ai pas été assez clair , je vais tenter de préciser mon problème ...

Donc je développe une bibliothèque d'outils que l'on va nommer : "useful_tools.jar".

Dans cette bibliothèque, j'ai une classe : "Useful.java" qui contient une méthode static : "search(String principal, String queryText)".

J'ai commenté ma méthode "search" avec des balises javadoc (cf. ci dessous) dans le but de fournir au développeur qui utilisera cette méthode de l'aide sur les paramètres à passer.

/**
* Permet d'exécuter une requête de recherche
*
* @param Utilisateur
* @param Requete a executer
*/

Lorsque j'embarque mon "useful.jar" dans un autre projet et que j'appelle : "Useful.search" sous Eclipse j'ai en infobulle au moment de l'auto complétion : "search(String arg1, String arg2)".

Je pensais que le fait de mettre les balises javadoc ferait s'afficher :
"search(String Utilisateur, String Requete a executer)"

Si j'embarque dans la génération du .jar la javadoc générée cela ne change rien...

Pour faciliter le travail des développeurs souhaitant utiliser mon .jar, je souhaiterais trouver comment pouvoir rendre plus explicite la description des paramètres à passer.

Merci par avance pour votre aide !

[adiGuba]

Ok : cela n'a rien à voir avec les servlet/JSP je déplace dans le forum eclipse.


Pour l'autocomplétion, eclipse utilise la réflection pour retrouver les classes, les méthodes et leurs paramètres depuis les fichiers *.class. Or ces derniers ne contiennent pas les noms des paramètres.

C'est pourquoi eclipse t'affiche arg1, arg2, etc.


Afin d'avoir une autocomplétion complète, il faut en plus :

• Soit les fichiers sources (et dans ce cas il décrypte le code et les balises javadoc).
• Soit la javadoc généré en HTML

Pour cela, dans eclipse, il faut aller dans les propriétés de l'archive et spécifier les chemins vers les sources ET/OU la javadoc (qui peuvent être soit dans un répertoire, soit dans une archive jar/zip).

Cela permet également de voir les sources via Ctrl+Clic ET/OU d'aller directement dans la javadoc via Ctrl+F1 (si je me rappelle bien).


a++

[ruda.tom]

J'ai suivi ton conseil, dans la construction de mon archive j'ai ajouté la javadoc dans un répertoire : JavaDoc.

Puis dans le projet utilisant mon archive , j'ai précisé au niveau de l'archive l'emplacement de la javadoc :

1-Propriétés du projet > Java Build Path > Onglet Libraries
2-Edit sur "Javadoc Location"
3-Puis sélection de l'option Javadoc in archive.
4-Archive path : Emplacement + nom de l'archive
5-Path within archive : Javadoc (nom de mon répertoire au sein de l'archive contenant ma javadoc)

Lorsque je valide l'emplacement de la javadoc, il me dit que c'est bon et me l'ouvre dans mon navigateur.

Par contre lorsque j'utilise les méthodes de mes classes de mon archive j'ai toujours dans les infos bulles arg1, arg2, ...

Du coup j'ai ajouté les sources à mon archive et au lieu d'indiquer l'emplacement de la javadoc, j'ai indiqué l'emplacement de mes sources (c'est à dire mon archive) et du coup cela fonctionne effectivement !

J'aurais préféré pouvoir éviter d'intégrer mes sources dans le .jar mais bon dans ce cas on ne peut peut être pas avoir le beurre et l'argent du beurre ...

En tout cas merci pour ton aide !