Utilisez l'annotation pour spécifier quelles classes/interfaces doivent générer javadoc?

Question

J'ai un programme java et je veux générer javadoc pour les classes/interfaces. Cependant, je veux juste générer javadoc pour certaines classes et interfaces. Je veux juste savoir si je peux ajouter une annotation au début de chaque classe/interface pour indiquer que cette classe/interface ne doit pas être générée javadoc (quelque chose comme @ no-generate-javadoc)

Est-ce que quelqu'un a des idées, s'il vous plaît?

Merci

Answer 1

Merci de mentionner notre outil - DocFlex/Javadoc

Soit dit en passant, à l'exclusion des classes simplement et les membres ne sont pas toute l'histoire. Le JavaDoc généré doit être cohérent après cela.

Par exemple, supposons que nous avons la situation suivante:

• classe C1 étend la classe C2
• classe C2 étend la classe de classe C3
• C3 contient une méthode publique m() - qui est censé être documenté

Maintenant, supposons que la classe C3 doit être exclue de la documentation. Que va-t-il se passer avec la méthode m()? Il doit être indiqué dans la documentation comme déclaré dans la classe C2! Ensuite, pour la classe C1, m() doit apparaître comme hérité de la classe C2 (plutôt que de la classe C3, comme c'est actuellement le cas dans le code).

La même situation se présente avec les champs, ce qui est en réalité encore plus compliqué, car les champs avec des noms identiques ne se surchargent pas mais s'observent mutuellement.Par exemple

• classe C1 étend la classe C2
• classe C2 implémente l'interface I
• classe C2 contient un champ privé F
• Interface I contient un champ public F - qui pourrait être documenté

Supposons que l'interface I doit être exclue de la documentation. Que faire avec le champ I.F? En fait, rien! Il ne devrait pas figurer dans la documentation car il est masqué par C2.F, qui est privé et, par conséquent, doit être invisible.

Est-ce que le simple réglage (délégation) de la norme Doclet résout de tels problèmes?

Notre outil fait!

Answer 2

rédaction de votre propre doclet est realtively simple et vous donnera exactement ce que vous voulez. Vous pouvez toujours déléguer au doclet standard, votre implémentation doit donc uniquement inclure vos modifications spécifiques. Le ExcludeDoclet serait un bon point de départ. Il lit les classes exclues d'un fichier. Vous obtenez des exclusions par annotation en appelant la méthode annotations() sur ClassDoc (en fait c'est la classe de base, ProgramElementDoc) pour récupérer les annotations, puis vérifiez-les par rapport aux annotations d'exclusion que vous souhaitez. Si vous le souhaitez, vous pouvez aussi le faire récursive pour superclasses et les interfaces mises en œuvre,