Type générique <P> converti en balise de paragraphe dans Javadoc

Question

J'ai une classe Java avec un type générique P. Je veux la documenter dans Javadoc. Normalement, je fais simplement ceci :

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

Cela apparaît bien dans la Javadoc actuelle. Cependant, CheckStyle m'avertit que je dois documenter le type P car il rend <P> comme un paragraphe HTML. De plus, le formateur Eclipse l'interprète également comme un paragraphe, ce qui perturbe le formatage.

Existe-t-il une meilleure façon de documenter les paramètres de type avec le type P ? Je sais que je peux désactiver le formateur Eclipse pour ne plus formater automatiquement la javadoc, mais je ne préfère pas (et cela ne résoudrait pas le problème du checkstyle de toute façon).

Je sais aussi que je peux simplement renommer P en quelque chose d'autre, mais étant donné le nombre de types génériques avec lesquels je travaille ici, cela rendrait les choses beaucoup moins lisibles.

Answer 1

Il s'agit d'un bug dans CheckStyle.

El documentation Javadoc officielle dit que cette notation est correcte :

Exemple d'un paramètre de type d'une classe :

 /**
  * @param <E> Type of element stored in a list
  */

Si vous êtes coincé avec cette version de CheckStyle, alors la seule façon de satisfaire aux deux contraintes est de renommer votre fichier P à un autre type de paramètre.

Answer 2

Il suffit de sauter les caractères "<" et ">". Ils ne font pas partie du nom du type ; ils font partie de la syntaxe.

@param P the type of publisher

(Je ne sais pas comment cela fonctionne avec CheckStyle, mais Eclipse devrait être satisfait).