代码之家 › 专栏 › 技术社区 › Bozho

JavaDoc“使用”部分-为什么缺少它?

javadoc java

Bozho · 技术社区 · 15 年前

在javadocs中,一些API(外部 java.lang 和 java.util ) "Use" 缺少节。

XMLStreamReader 例如。基于JavaDoc,如果你不知道API的哪些类会返回你需要的类,这有点令人不快,你必须使用一些其他的技巧(比如IDE特性)来实现这一点。

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

2 回复 | 直到 15 年前

skaffman 15 年前

为xmlstreamreader发布的链接是针对javadocs的 http://java.sun.com/webservice 而不是核心的JavaseAPI。

JavaDoc XMLStreamReader in the core javadoc 但是,确实完全填充了“使用”部分。

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

Community CDub 8 年前

JavaX.xML.Sur.xMLStaveRe读器类是Java的一部分。 extension 机制,因此可以用特定的实现替换它们(在本例中,如果我正确地回忆起 stax )。

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

编辑您为XMLStreamReader提供的链接来自Java 1.5的Web Services包。我不知道为什么使用部分丢失了,但是不管它的价值如何,它都包含在Java SE 6 API中(参见 here )希望这有帮助…

推荐文章

Stephen.lin · 当鼠标向上移动弹出java文档时,IntelliJ思想如何像eclipse一样工作

7 年前

Vulkanos · 我可以在自定义doclet的帮助下生成Javadoc注释吗?

7 年前

Fraquack · Kotlin-接口方法引发的文档异常

7 年前

Adrien Aacha · Javadocs-@param name未找到

7 年前

Mohan · 为具有(模拟的)可选/默认参数的函数编写Javadoc

7 年前

Jai · vararg方法的Javadoc链接

7 年前

grandouassou · 使用Java Bean验证注释从POJO生成文档

7 年前

drJava · 在JavaDoc中将方法参数与类成员链接

7 年前

Batman · Javadoc和继承的类

9 年前

CrypticStorm · IntelliJ Javadoc每行增加一个星号

10 年前