Discussion :

[elitost]

Bonjour,

Je cherche une aide sur la liste des tags utilisables dans la JAVADOC.

Ou pourrait on trouver cela ?

Merci d'avance

[adiGuba]

Salut,

Ou pourrait on trouver cela ?

Dans la doc. officiel : http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html#javadoctags
(pour les tags standards en tout cas...)

a++

[elitost]

Et pour les autres tags non standards ?

Je pense notamment à ceux utilisés dans ECLIPSE.

Existe t'il pour cela de la documentation ?

Merci d'avance

[adiGuba]

Et pour les autres tags non standards ?

Je pense notamment à ceux utilisés dans ECLIPSE.

De quel tags parles-tu exactement ? Eclipse ne possède pas de tag javadoc particulier à ce que je saches...

a++

[elitost]

hummm..

Par exemple , @date , @time, @tags

En fait l'objet de ma demande est surtout de savoir comment automatiser la recupération des paramètres IN/OUT avec le type et le nom

[adiGuba]

hummm..

Par exemple , @date , @time, @tags

Je ne vois pas du tout ce que c'est... Tu utilises des plugins ???
C'est eclipse qui te les génère ou c'est dans un source que tu as récupéré ?

En fait l'objet de ma demande est surtout de savoir comment automatiser la recupération des paramètres IN/OUT avec le type et le nom

Les paramètres de quoi ? D'une méthode ?
Tu veux les récupérer quand ? Lors de la création de la documentation ? pendant l'exécution de ton programme ?

Que veux tu dire par paramètres "IN/OUT", il n'y a pas de tels notions en Java...

a++

[elitost]

Je ne vois pas du tout ce que c'est... Tu utilises des plugins ???
C'est eclipse qui te les génère ou c'est dans un source que tu as récupéré ?

Dans les préférences d'ECLIPSE, dans Code Template, en éditant un template il y a un bouton permettant d'insérer des tags ( apparement en + des standards )

Les paramètres de quoi ? D'une méthode ?

Oui

Que veux tu dire par paramètres "IN/OUT", il n'y a pas de tels notions en Java...

En fait, les paramètres d'une méthodes, et la valeur de retour :

Ex:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
public Resultset methode (String param1) {
 
...
 
return resultset;
}

Je souhaiterais dans ma javadoc générée, que les types String, Resultset et le nom param1 soient récupérés automatiquement à partir de la méthode nommée "methode" :

Param:
String param1 Description de mon paramètre

Return :
Resultset Description de la valeur de retour

[viena]

le tag des parametres d'une methode c'est @param et celui d'un retour c'est @return

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
@param bouh String 
@return String

[adiGuba]

Je ne vois pas du tout ce que c'est... Tu utilises des plugins ???
C'est eclipse qui te les génère ou c'est dans un source que tu as récupéré ?

Dans les préférences d'ECLIPSE, dans Code Template, en éditant un template il y a un bouton permettant d'insérer des tags ( apparement en + des standards )

Ok !!!!
Ce ne sont pas des tags Javadoc mais des variables propres à eclipse qui sont utilisé lors de la génération de code/commentaire : et c'est ${date} et non @date

C'est surement documenté dans la doc d'eclipse... mais bon il n'y en as pas vraiment beaucoup et les noms sont assez explicites...

Je souhaiterais dans ma javadoc générée, que les types String, Resultset et le nom param1 soient récupérés automatiquement à partir de la méthode nommée "methode" :

Param:
String param1 Description de mon paramètre

Return :
Resultset Description de la valeur de retour

Si j'ai bien compris, tu as la méthode :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
public Resultset methode (String param1) { 
	...
}

Et tu veux qu'eclipse te génère automatiquement :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
/**
 * @param param1
 * @return
 */
public Resultset methode (String param1) { 
	...
}

Pour que tu n'ai plus qu'à renseigner les différentes champs ?


Si c'est le cas il suffit de laisser le template standard d'eclipse pour les méthodes :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
/**
 * ${tags}
 */

${tags} sera remplacé par les tags javadoc de la méthode...

a++

[elitost]

Ok, merci beaucoup