web-dev-qa-db-fra.com

Existe-t-il une balise javadoc pour documenter les paramètres de type générique?

J'ai parcouru la documentation javadoc sur le site de Sun pour savoir 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, semblable à l'habituel @param, mais applicable aux types ainsi qu'aux méthodes, par ex.

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

Je soupçonne qu’il n’existe pas de balise de ce type. Je ne trouve aucune mention de cela nulle part, et la documentation de l’API JavaSE n’en montre aucun signe, mais cela semble être une étrange omission. Est-ce que quelqu'un peut me réparer?

158
skaffman

Cela devrait être fait comme ça:

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

}

Source

224
Timo Willemsen

Oui. Utilisez simplement la balise @param et incluez des angles entre les paramètres de type.

Comme ça:

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