comment générer javaDoc à partir d'un fichier jaxb

Question

Je travaille avec Jaxb. et je voudrais générer des fichiers javaDoc à partir de ces classes, est-ce la même chose que je le ferais pour un fichier java régulier?

Answer 1

En supposant que vous avez généré .java fichiers de .xsd - oui, ce sont des classes régulières que vous pouvez modifier, commenter et documenter.

Answer 2

Vous pouvez utiliser le xs:annotation avec xs:documentation et jaxb les ramasse et les rend javadoc sur la classe.

Notes:

• lorsque le xs: étiquette de documentation était en dehors des xs: tag complexType, il ne ramassez pas (naturellement)
• Je suppose que la même chose peut être fait à le attribut/niveau d'élément dans le .xsd pour les champs de la classe, mais n'a pas essayé.
• la sortie est moche si vous essayez de mettre les balises HTML dans la documentation. Il y a probablement un moyen de contourner cela, mais je n'ai pas essayé non plus.

 
    <xs:complexType name="TypeThatBecomesJavaClass"> 
     <xs:annotation> 
     <xs:documentation> 
      This becomes javadoc for TypeThatBecomesJavaClass 
     </xs:documentation> 
    </xs:annotation> 
    ... etc ... 

Answer 3

Une approche plus directe (du tutoriel JAXB) qui répond aux préoccupations ci-dessus: http://jaxb.java.net/tutorial/section_5_4-Adding-Documentation.html#Adding%20Documentation