Javadoc“使用”部分 - 为什么它丢失了?

时间:2010-01-22 15:31:56

标签: java javadoc

在javadocs中,某些API(java.langjava.util之外)"Use"部分缺失。

例如

XMLStreamReader。根据javadoc,您无法分辨哪些类返回所需的类,并且您必须使用其他一些技巧(如IDE功能)来执行此操作,这有点令人不愉快。

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

2 个答案:

答案 0 :(得分:1)

像javax.xml.stream.XMLStreamReader这样的类是Java extension机制的一部分,因此它们可以替换为特定的实现(在这种情况下,如果我没记错的话,是stax的实现)

您应该通过工厂方法获取实际的服务类,方法是使用两个公共类XMLInputFactory和XMLOutputFactory。根据设计,您不需要知道实际的实现类是什么。

编辑:您为XMLStreamReader提供的链接来自java 1.5的Web服务包。我不知道为什么缺少使用部分,但无论它的价值如何,在java se 6 api中都包含它(参见here)。希望这会有所帮助...

答案 1 :(得分:1)

您为XMLStreamReader发布的链接是针对http://java.sun.com/webservice下的javadoc,而不是针对核心JavaSE API。

XMLStreamReader in the core javadoc的javadoc确实填充了“使用”部分。

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