J'ai parcouru la documentation javadoc sur le site de Sun, en essayant de trouver s'il existe une balise javadoc qui peut être utilisée pour documenter la signature de type générique d'une classe ou d'une méthode.
Quelque chose comme @typeparam
similaire à l'habituel @param
mais applicable aux types comme aux méthodes, par exemple
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Je soupçonne qu'une telle balise n'existe pas - je n'en trouve aucune mention nulle part, et les documents de l'API JavaSE n'en montrent aucun signe, mais cela semble être une omission étrange. Quelqu'un peut-il m'éclairer ?
7 votes
Pour écrire de bonnes javadocs ?
2 votes
Sachez que pour le plus il n'y a vraiment rien d'intéressant à dire sur le paramètre de type, car celui-ci est essentiellement défini par la façon dont il apparaît dans les méthodes de l'objet. Je sauterais
@param <T>
la plupart du temps et ne l'utilise que lorsque ce n'est vraiment pas clair.4 votes
Je vois ce que vous dites, mais selon ce raisonnement, la même chose s'applique à l'utilisation de
@param
pour les paramètres de la méthode. Les normes de codage de Sun stipulent explicitement que@param
doit être utilisé même si la signification du paramètre de la méthode est claire.3 votes
En plus de cela. Une bonne programmation d'API doit être aussi auto-documentée que possible. Est-ce que cela signifie qu'une API n'a pas besoin de documentation ? Non.
0 votes
El documentation de @param donne des instructions pour les paramètres de type. Il est vrai qu'Oracle pourrait faire une meilleure publicité pour ce document.