如何从 jaxb 文件生成 javaDoc答案

【问题标题】：how generate javaDoc from a jaxb file如何从 jaxb 文件生成 javaDoc
【发布时间】：2011-01-25 01:32:27
【问题描述】：

我正在与 Jaxb 合作。我想从这些类中生成 javaDoc 文件，这与我对常规 java 文件的处理方式相同吗？

【问题讨论】：

@special0ne 您是否设法解决了您的问题？分享

标签： java documentation jaxb javadoc documentation-generation

【解决方案1】：

您可以将xs:annotation 与xs:documentation 一起使用，然后 jaxb 将它们拾取并在类中生成它们的 javadoc。

注意事项：

当 xs:documentation 标签是在 xs:complexType 标签之外，它没接（可以理解）
我假设在 .xsd 中的属性/元素级别对于类的领域，但没有尝试。
如果您尝试放置 HTML 标记，则输出很难看在文档中。有可能是一种解决方法，但我也没试过。

<xs:complexType name="TypeThatBecomesJavaClass"> <xs:annotation> <xs:documentation> 这成为 TypeThatBecomesJavaClass 的 javadoc </xs:documentation> </xs:annotation> ... 等等 ...

【讨论】：

【解决方案2】：

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

【讨论】：

是的，一条评论只需要 9 行，yuk！
如果 Schema 不是由您创作的，并且是一个大型方案，这将不起作用。

【解决方案3】：

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

【讨论】：

Egh... 不应手动编辑生成的文件。重新生成后此类编辑将丢失！