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

Question

我是Java的新手，需要处理需要使用开源软件的项目。我很难理解这些Java API的文档。 作为示例，您能否告诉我如何使用相关的java类RemoteXmlSimpleSearchEngineBase，基于其Java API。

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

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

Answer 1

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

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

1. 实施了哪些接口
2. 存在直接已知的子类/实现者
3. 你看到这个类是抽象的
4. 由该类添加/覆盖哪些方法
5. 添加了哪些方法
6. 方法及其参数的前/后条件（有时未列出）
7. ...

但是，您通常不会获得一般概念或调用方法时，如何为各种用例等配置类。您根本无法将其全部放入API文档中。

Answer 2

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

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

您有一些示例和大量信息。

Answer 3

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

可悲的是，默认情况下不生成后者（在你的问题的示例中也缺少）。

Answer 4

通常，JavaDoc概述页面将概述API和代码示例。这实际上是Carrot2 JavaDoc的情况：

http://download.carrot2.org/stable/javadoc/overview-summary.html#overview_description