J'ai parcouru la documentation javadoc sur le site de Sun, 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 ainsi qu'aux méthodes, par exemple
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Je soupçonne qu'il n'y a pas de telle balise - je ne peux en trouver aucune mention, et la documentation de l'API JavaSE n'en montre aucun signe, mais cela semble être une étrange omission. Quelqu'un peut-il me redresser?
@param <T>
plupart du temps et ne l'utilisais que lorsque ce n'était vraiment pas clair.@param
paramètres de méthode. Les normes de codage de Sun indiquent explicitement que cela@param
devrait être utilisé même si la signification du paramètre de méthode est claire.Réponses:
Cela devrait être fait comme ceci:
La source
la source
Collection
) ne l'utilisent pas, cependant.Oui. Utilisez simplement la balise @param et incluez des crochets angulaires autour du paramètre de type.
Comme ça:
la source