Je dois exclure certaines des méthodes publiques d'une classe d'être incluses dans javadocs. J'ai essayé ExcludeDoclet (six legs) de Chris Nokleberg. Mais le doclet donne un léger problème: Si les autres méthodes de la classe retournent List (ou tout autre générique), au lieu d'être affiché dans le javadoc en tant que List, le type de retour est juste affiché en Liste (sans les informations génériques Est-ce que quelqu'un peut donner un indice ou fournir un travail sur comment résoudre ce problème?javadoc exclut certaines méthodes publiques de la classe
Répondre
Je suppose que les méthodes que vous voulez exclure de javadoc sont des méthodes publiques que vous ne voulez pas que votre client utilise. En d'autres termes, ces méthodes sont deprecated. Ce que vous devez faire est d'utiliser l'annotation @Deprecated. Comme ceci:
@Deprecated public void badMethod() {
...
}
Maintenant, le badMethod() est obsolète. Si quelqu'un utilise badMethod() dans son code, il recevra un avertissement du compilateur (qu'il utilise une méthode obsolète). Cependant, l'annotation @Deprecated n'exclut pas la méthode obsolète de javadoc. Voici ce que vous devez faire pour exclure la méthode de javadoc: Lorsque vous générez javadoc, utilisez l'option de ligne nodeprecated javadoc cmd. L'option -nodeprecated empêche la génération de toute API obsolète dans la documentation. Donc, si vous utilisez l'annotation @Deprecated et que vous générez javadoc avec l'option -nodeprecated, votre mauvaise méthode n'apparaîtra pas dans le javadoc. Mais à mon avis, vous ne devriez pas exclure les méthodes publiques obsolètes de votre javadoc. Il est préférable qu'ils apparaissent dans la documentation avec une explication de la raison pour laquelle la méthode est obsolète et de ce qu'elle doit utiliser à la place.
+1 pour le dernier paragraphe. Les utilisateurs de l'ancien code doivent voir une référence à la nouvelle méthode qu'ils doivent utiliser. La plupart des utilisateurs sont paresseux, donc si vous ne le rendez pas très facile pour eux, ils laisseront l'utilisation de la méthode obsolète. –
- 1. Comment exclure des méthodes publiques obsolètes de Javadoc?
- 2. Sécurité de service WCF avec certaines méthodes publiques et certaines méthodes privées
- 3. apprendre les méthodes publiques d'une classe
- 4. Regroupement des méthodes javadoc
- 5. JQuery - Widget Méthodes publiques
- 6. Accès aux méthodes publiques d'activité
- 7. Javadoc {@inheritDoc} classe de balises
- 8. Eclipse: Comment trouver toutes les classes/méthodes (publiques) sans commentaires Javadoc?
- 9. Éviter les méthodes publiques dans une autre classe?
- 10. trop de méthodes publiques avec @ModelAttribute
- 11. Pile commune pour certaines variables publiques
- 12. JavaDoc: champs et méthodes privés
- 13. La classe qui implémente Serializable doit implémenter certaines méthodes?
- 14. Réutilisation de Javadoc et méthodes surchargées
- 15. surcharge Javadoc en héritant de la classe
- 16. La manière la plus simple de se cacher Une partie des méthodes/interfaces publiques d'une classe
- 17. La règle du squid "undocumentedapi" n'exclut pas certaines méthodes getter
- 18. Méthodes publiques Inaccessible en Array Object
- 19. __équivalent équivalent pour les méthodes publiques
- 20. Par défaut, le modèle ActiveRecord exclut certaines conditions de requête?
- 21. Accès à la base de données via les méthodes publiques
- 22. implémenter certaines méthodes d'interface explicitement et certaines méthodes implicitement
- 23. javadoc: affiche également les descriptions des méthodes de la classe parente
- 24. action -Méthodes vs méthodes publiques dans les cadres PHP
- 25. But des méthodes publiques NonAction dans MVC
- 26. JavaDoc manquant pour les méthodes dans Eclipse
- 27. Python: méthodes publiques appelant leurs méthodes privées 'brother'
- 28. Méthodes publiques dans les classes private-package
- 29. Découvrez les méthodes publiques d'une bibliothèque partagée
- 30. JAVADOC pour les méthodes privées (BlueJ)
question similaire: http://stackoverflow.com/questions/1120455/how-do-i-exclude-a-specific-method-constructor-from-the-results-of-the-javadoc-an/4815466# 4815466 –
étant affiché en Liste. – Astha
Je publie de nouveau la question. en raison des crochets angulaires, certaines parties ont été interprétées comme des étiquettes. – Astha