OVH Cloud OVH Cloud

Javadoc

1 réponse
Avatar
matjmc
Salut les pros !

Pourriez vous me communiquer quelques infos sur les tags de la javadoc

/**@author matjmc
* @since Aout 2003
* @version 1.0
* @deprecated classes et methodes dépréciées
* @docRoot "à vrai dire je ne sais pas trop"
* @exception gestion des exceptions
* @inheritdoc "je l'ignore également"
* @link lien web http:\\www.chez.com\matjmc
* @linkplain les explications ne sont pas très claires
* @param parametres
* @return valeur de retour
* @see ?
* @serial ?
* @serialData ?
* @serialField ?
* @throws Gestion des processus
* @value ?
*
*/

J'utilise Eclipse puis je configurer des valeurs par défaut, je pense que
oui car @author à une valeur par défaut
Merci d'avance pour vos infos
A++ Jean Marc

1 réponse

Avatar
Nicolas Delsaux
Le 07.08 2003, "matjmc" s'est levé(e) et s'est dit
"tiens, je vais écrire aux mecs de fr.comp.lang.java"

Salut les pros !

Pourriez vous me communiquer quelques infos sur les tags de la
javadoc


Tu ne vois vraiment pas à quoi ça sert ? C'est pourtant indiqué dans la
doc de ton JDK ? La page "javadoc - The Java API Documentation
Generator" de ta doc de JDK donne par exemple la liste de tous les tags,
des endroits où les utiliser, ... C'est donc de là que je tire mes
réponses.

/**@author matjmc
* @since Aout 2003
* @version 1.0
* @deprecated classes et methodes dépréciées
* @docRoot "à vrai dire je ne sais pas trop"
source de la documentation générée, pour inclure des images, des

fichiers, ...

* @exception gestion des exceptions
* @inheritdoc "je l'ignore également"
Copie la doc depuis une superclasse


* @link lien web http:www.chez.commatjmc
* @linkplain les explications ne sont pas très claires
Le texte du lien sera dans la police normale.


* @param parametres
* @return valeur de retour
* @see ?
Voir aussi ...

Très pratique pour faire un lien entre la javadoc d'une méthode et celle
d'une des méthodes contenues.

* @serial ?
Documentes les champs sérialisés, de manière à les faire apparaître dans

la page de la classe sérialisée.

* @serialData ?
* @serialField ?
Voir aussi.


* @throws Gestion des processus
* @value ?
Permet de donner la valeur des champs static final.

*
*/

J'utilise Eclipse puis je configurer des valeurs par défaut, je pense
que oui car @author à une valeur par défaut
Merci d'avance pour vos infos


Tu vas dans tes préférences Java/Code generation/Code comments

A++ Jean Marc






--
Nicolas Delsaux
"L'humour est une chose trop sérieuse pour être confiée aux rigolos."
Marcel Gotlib