如何根据java类的API文档使用它。

Question

我是Java的新手，需要在一个需要使用开源软件的项目上工作。我对理解这些Java API的文档感到非常困惑。作为一个例子，您能告诉我如何基于java API使用相关的Java类RemoteXmlSimpleSearchEngineBase吗？

请参阅此链接http://download.carrot2.org/stable/javadoc/org/carrot2/source/xml/RemoteXmlSimpleSearchEngineBase.html

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

Answer 1

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

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

1. 哪些接口是直接已知的子类/实现者
2. 您可以看到类是抽象的，
3. 哪些方法是由类
4. 添加/覆盖的，哪些方法是方法及其参数的抽象(有时不是抽象的

然而，你通常不理解一般的概念，或者什么时候调用一个方法，如何为不同的用例配置一个类等等。你不能简单地把这些都放到一个API文档中。

Answer 2

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

http://project.carrot2.org/documentation.html

你有一些例子和大量的信息。

Answer 3

当我试图了解一些API的概况时，我经常发现有用的是类/接口树，更重要的是“使用”页面-它们显示哪些其他类/接口在他们的API中使用这个类/接口。这展示了如何获取某种类型的对象(通过查找返回值)，或者如何处理某些对象(使用其方法本身除外)。

遗憾的是，后者在默认情况下不会生成(在您的问题示例中也没有生成)。