Classe de balises Javadoc {@inheritDoc}
Je souhaite utiliser le {@inheritDoc} classe pour hériter des méthodes de ma classe abstraite. Dans la documentation de la classe abstraite, je me réfère à la classe abstraite par son nom. Comment puis-je marquer cela alors quand la sous-classe hérite de la documentation de la super classe, elle remplace le nom de la classe abstraite par le nom de la sous-classe?
Ce que vous décrivez n'est pas pris en charge par l'outil de génération javadoc.
Et je pense qu'il y a un bonne raison pour cela aussi:
Si votre méthode dans la sous-classe est simplement une implémentation d'une méthode abstraite, alors je pense qu'il serait correct de laisser le nom de la classe abstraite là-dedans.
D'un autre côté, si votre méthode dans la sous-classe n'est pas seulement une simple implémentation et fait quelque chose de plus remarquable (assez pour être mentionné dans le javadoc), alors vous devriez écrire un nouveau javadoc sur la méthode dans la sous-classe, à la place d'invoquer inheritDoc.
Je ne suis pas au courant d'un moyen, mais vous pourriez expliquer pourquoi vous voulez {@inheritDoc} pour ce faire. Je peux me méprendre, mais cela semble déroutant. Vous pouvez documenter la variation de votre implémentation concrète du parent et utiliser @see pour faire référence au contrat dans la classe abstraite. Remarque " Copie automatique des commentaires de méthode " peut éviter la nécessité d'une explication {@inheritDoc} .
Vous pouvez également, IIRC, écrire du texte supplémentaire autour du {@inheritDoc} tag dans vos propres commentaires.