java - 如何使用基于其 API 文档的 java 类

Question

我对 Java 很陌生，需要从事一个需要使用开源软件的项目。我对理解那些 Java API 的文档感到非常困惑。作为一个例子，你能告诉我如何使用相关的java类，RemoteXmlSimpleSearchEngineBase，基于它的Java API。

我对这个推导过程很感兴趣，这样我就可以在阅读其API文档的基础上使用其他java类。谢谢。

score 2 · Accepted Answer

JavaDoc 通常不解释库的一般概念，而只是解释该类的 API。它可能包含更多有用的信息（如 JDK JavaDocs 所做的），但通常您应该尝试获取用户手册、参考或入门指南。

从 JavaDoc 中您仍然可以学到一些东西：

但是，您通常不了解一般概念或调用方法时，如何为各种用例配置类等。您根本无法将所有这些都放入 API 文档中。

score 0 · Accepted Answer

也许你应该看看项目文档：

你有一些例子和很多信息。

score 0 · Accepted Answer

在尝试了解某些 API 时，我经常发现有用的是类/接口树，甚至更多的是“使用”页面——它们显示了哪些其他类/接口在他们的 API 中使用了这个类/接口。这显示了如何获取某种类型的对象（通过查找返回值），或如何处理某些对象（使用其方法本身除外）。

可悲的是，默认情况下不会生成后者（并且在您的问题示例中也没有生成）。

score 0 · Accepted Answer

很多时候，JavaDoc 概述页面将有一些 API 和代码示例的概述。这实际上是 Carrot2 JavaDoc 的情况：

4 回答 4