programa - javadoc eclipse
¿Hay una etiqueta javadoc para documentar los parámetros de tipo genérico? (2)
He estado buscando en la documentación de javadoc en el sitio de Sun, tratando de encontrar si hay una etiqueta javadoc que se pueda usar para documentar la firma de tipo genérico de una clase o método.
Algo como @typeparam
, similar al @param
habitual, pero aplicable tanto a los tipos como a los métodos, por ejemplo
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Sospecho que no existe tal etiqueta, no puedo encontrarla en ninguna parte, y los documentos API de JavaSE no muestran ningún signo de ello, pero parece una omisión extraña. ¿Puede alguien ponerme en lo cierto?
Debería hacerse así:
/**
* @param <T> This describes my type parameter
*/
class MyClass<T>{
}
Sí. Simplemente use la etiqueta @param e incluya corchetes angulares alrededor del parámetro de tipo.
Me gusta esto:
/**
* @param <T> This describes my type parameter
*/