method - javadoc best practices

Tipo genérico<P> convertido a etiqueta de párrafo en Javadoc (4)

Descubrimos que pulsar Ctrl + S para guardar y luego Ctrl-Z para deshacer el formato guardará correctamente el Javadoc con una etiqueta @param <P> .

Tengo una clase Java con un tipo genérico P. Quiero documentarla en Javadoc. Normalmente solo hago esto:

/** * ... * @param <P> the type of publisher */

Esto se muestra bien en Javadoc real. Sin embargo, CheckStyle me advierte que necesito documentar el tipo P porque representa <P> como un párrafo HTML. Además, el formateador Eclipse lo interpreta también como un párrafo, por lo que confunde el formato.

¿Hay una mejor manera de documentar los parámetros de tipo con el tipo P? Sé que puedo deshabilitar el formateador de Eclipse para que ya no formatee automáticamente javadoc, pero preferiría no hacerlo (y de todos modos no resolvería el problema del estilo de comprobación).

También sé que solo puedo cambiar el nombre de P a otra cosa, pero dado el número de tipos genéricos con los que trabajo aquí, las cosas serían mucho menos legibles.

Este es un error en CheckStyle.

La documentación oficial de Javadoc dice que la notación es correcta:

Ejemplo de un parámetro de tipo de una clase:
/** * @param <E> Type of element stored in a list */

Si está atascado con esta versión de CheckStyle, entonces la única manera de satisfacer ambas restricciones es cambiar el nombre de su parámetro de tipo P a otra cosa.

PARA POSTERIDAD: Resulta que Checkstyle lo maneja bien. El problema es que el espacio en blanco agregado por el formateador Eclipse hizo que Checkstyle (razonablemente) argumentara que el Javadoc era incorrecto. También encontré un informe de error existente para este error en Eclipse: https://bugs.eclipse.org/bugs/show_bug.cgi?id=121728

Solo salta los caracteres "<" y ">". No son parte del nombre del tipo; Son parte de la sintaxis.

@param P the type of publisher

(No estoy seguro de cómo funciona con CheckStyle, pero Eclipse debería estar satisfecho).