Je ne veux pas écrire des commentaires javadoc redondants. Comme vous pouvez le constater, @param x est de manière redondante. Existe-t-il une balise Javadoc pour définir une référence de @param x dans la classe B à @param x dans la classe A > Ou suis-je autorisé à laisser simplement sortir?
3 Réponses :
Vous ne pouvez pas le laisser, Je ne pense pas qu'il y ait un moyen de "factoriser" cela non plus. Vous devrez tout simplement écrire tous, désolé ... javadoc n'est pas intelligent, il ne fait que analyser les commentaires, il ne peut pas dire que le paramètre x pour le constructeur B est la même chose que le constructeur, même s'il y a héritage en jeu.
Avec des méthodes, il devrait fonctionner: Si vous écrasez ou implémentez une méthode, les paramètres sont copiés si non fournis.
Les constructeurs ne sont pas hérités et même moins à un constructeur avec d'autres types de paramètres. Javadoc n'a aucun moyen de savoir que vous passez le paramètre à un autre constructeur, car il n'interprète pas le contenu des méthodes / constructeurs, seule l'interface extérieure.
Donc, je suppose que vous n'êtes pas de chance, si vous ne voulez pas écrire votre propre docut ou modifier le doculet standard (et même vous auriez à dire en quelque sorte à quel constructeur hériter des paramètres). (Ce serait un ajout utile, également pour plusieurs méthodes similaires dans la même classe, je pense.)
Si vous remplissez une méthode parent, si vous n'incluez pas la plupart des IDES Javadoc affichera la méthode Javadoc pour la méthode des parents. Sinon, il n'ya aucun moyen de définir / se référer à des variables dans la syntaxe Javadoc.
Je prendrais un pas en arrière et demandez pourquoi vous documiez les paramètres qui semblent avoir une signification évidente. Si le code est auto-documentant en fonction des noms que vous choisissez, Javadoc est largement pertinent.
@John Ceci est un exemple minimal, uniquement pour l'illustration.
Note à moi-même: {@InheritDoc} Permet au moins de copier un doc de méthode remplacée.
Même pour la méthode actuelle: Stackoverflow.com/questions / 1667212 / ...