He estado revisando la documentación de javadoc en el sitio de Sun, tratando de encontrar si hay una etiqueta javadoc que pueda usarse para documentar la firma de tipo genérico de una clase o método.
Algo parecido @typeparam
, similar a lo habitual @param
, pero aplicable tanto a los tipos como a los métodos, p. Ej.
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Sospecho que no existe tal etiqueta: no puedo encontrar ninguna mención de ella en ningún lado, y los documentos de la API JavaSE no muestran ningún signo de ello, pero parece una omisión extraña. ¿Alguien puede arreglarme?
@param <T>
mayor parte del tiempo y solo lo uso cuando realmente no está claro.@param
parámetros del método. Los estándares de codificación de Sun dicen explícitamente que@param
debe usarse incluso si el significado del parámetro del método es claro.Respuestas:
Debería hacerse así:
Fuente
fuente
Collection
) no lo usan.Si. Simplemente use la etiqueta @param e incluya corchetes angulares alrededor del parámetro de tipo.
Me gusta esto:
fuente