Javadoc“使用”部分 - 为什么缺少？

Question

在javadoc中的一些API（java.lang和java.util之外）缺少"Use"部分。例如

XMLStreamReader。你不能根据javadoc知道API的哪些类返回需要的类，并且你必须使用其他一些技巧（如IDE功能）来完成此操作。

是否有任何理由不在这些API中包含“使用”部分？

Answer 1

您为XMLStreamReader发布的链接适用于http://java.sun.com/webservice下的javadocs，而不是核心JavaSE API。

但是，对于XMLStreamReader in the core javadoc的javadoc确实已将“使用”部分完全填充。

至于他们为什么不同，我怀疑这只是一个质量控制问题。

Answer 2

像javax.xml.stream.XMLStreamReader这样的类是Java extension机制的一部分，因此它们可以用特定实现（在这种情况下，如果我正确记得，stax的实现）替换。

通过使用两个公共类XMLInputFactory和XMLOutputFactory，您应该通过工厂方法获得实际的服务类。在设计上，你不需要知道什么是实际的实施课程。

编辑：您为XMLStreamReader提供的链接来自Java 1.5的Web服务包。我不知道为什么使用部分丢失，但是无论它的价值如何，它都包含在内（参见here）。希望这有助于...