2011-01-27 3 views
2

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

+0

question similaire: http://stackoverflow.com/questions/1120455/how-do-i-exclude-a-specific-method-constructor-from-the-results-of-the-javadoc-an/4815466# 4815466 –

+0

étant affiché en Liste. – Astha

+0

Je publie de nouveau la question. en raison des crochets angulaires, certaines parties ont été interprétées comme des étiquettes. – Astha

Répondre

6

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.

+2

+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. –

Questions connexes