如何从jaxb文件生成javaDoc

时间:2010-03-08 16:38:14

标签: java documentation jaxb javadoc documentation-generation

我正在与Jaxb合作。我想从这些类生成javaDoc文件,它是否与我对常规java文件的方式相同?

3 个答案:

答案 0 :(得分:2)

您可以将xs:annotationxs:documentation一起使用,然后jaxb选择它们并在课堂上使用javadoc。

注意:

  • 当xs:documentation标记是 在xs:complexType标签之外,它 没有拿起(可以理解)
  • 我会假设同样可以做到 .xsd中的属性/元素级别 对于班级的领域,但没有尝试。
  • 如果您尝试放置HTML标记,则输出很难看 在文档中。有 可能是一种解决方法,但我 也没试过。

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

答案 1 :(得分:2)

更直接的方法(来自JAXB教程)解决了上述问题:http://jaxb.java.net/tutorial/section_5_4-Adding-Documentation.html#Adding%20Documentation

答案 2 :(得分:0)

假设您已从.java生成.xsd个文件 - 是的,它们是常规类,您可以修改,评论和记录。