173 votes

Existe-t-il une balise javadoc pour documenter les paramètres des types génériques ?

J'ai parcouru la documentation javadoc sur le site de Sun, en essayant de trouver s'il existe une balise javadoc qui peut être utilisée pour documenter la signature de type générique d'une classe ou d'une méthode.

Quelque chose comme @typeparam similaire à l'habituel @param mais applicable aux types comme aux méthodes, par exemple

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}

Je soupçonne qu'une telle balise n'existe pas - je n'en trouve aucune mention nulle part, et les documents de l'API JavaSE n'en montrent aucun signe, mais cela semble être une omission étrange. Quelqu'un peut-il m'éclairer ?

7 votes

Pour écrire de bonnes javadocs ?

2 votes

Sachez que pour le plus il n'y a vraiment rien d'intéressant à dire sur le paramètre de type, car celui-ci est essentiellement défini par la façon dont il apparaît dans les méthodes de l'objet. Je sauterais @param <T> la plupart du temps et ne l'utilise que lorsque ce n'est vraiment pas clair.

4 votes

Je vois ce que vous dites, mais selon ce raisonnement, la même chose s'applique à l'utilisation de @param pour les paramètres de la méthode. Les normes de codage de Sun stipulent explicitement que @param doit être utilisé même si la signification du paramètre de la méthode est claire.

248voto

Timo Willemsen Points 3625

Il faut faire comme ça :

/**
 * @param <T> This describes my type parameter
 */
class MyClass<T>{

}

Source :

6 votes

Doh.... OK, c'est d'une évidence embarrassante... mais cela pose la question de savoir pourquoi les classes JavaSE (par ex. Collection ) ne l'utilisent pas, cependant.

0 votes

C'est étrange, mais ce n'est pas documenté dans la documentation standard.

7 votes

28voto

Dave DiFranco Points 689

Oui. Il suffit d'utiliser la balise @param et d'inclure des crochets autour du paramètre de type.

Comme ça :

/**
 *  @param <T> This describes my type parameter
 */

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X