2010-01-06 13 views
129

He estado revisando 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.¿Hay una etiqueta javadoc para documentar los parámetros de tipo genérico?

Algo como @typeparam, similar al habitual, pero aplicable a tipos y métodos, por ejemplo.

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

sospecho que no hay tal etiqueta - No puedo encontrar ninguna mención de ella en cualquier lugar, y los documentos de la API JavaSE no muestran ningún signo de él, pero parece como una extraña omisión. ¿Puede alguien ponerme en lo cierto?

+7

Para escribir javadocs adecuados? –

+2

Tenga en cuenta que para las clases * most * no hay nada interesante que decir sobre el parámetro type, porque el parámetro type se define esencialmente por cómo aparece en los métodos del objeto. Me saltaría '@param ' la mayor parte del tiempo y solo lo usaré cuando no esté claro. –

+3

Veo lo que dice, pero según ese razonamiento, lo mismo se aplica al uso de '@ param' para los 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. – skaffman

Respuesta

178

se debe hacer como este:

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

} 

Source

+4

Doh .... Bien, eso es vergonzosamente obvio ... sin embargo, plantea la pregunta de por qué las clases JavaSE (por ejemplo, 'Collection') no lo usan. – skaffman

+0

Extraño, no está documentado en la documentación estándar. –

+5

LinkedList lo usa: http://java.sun.com/j2se/1.5.0/docs/api/java/util/LinkedList.html –

21

Sí. Simplemente use la etiqueta @param e incluya corchetes angulares alrededor del parámetro tipo.

De esta manera:

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