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

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. 实现了哪些接口(interface)
2. 存在哪些直接已知的子类/实现
3. 你看到这个类是抽象的
4. 该类添加/覆盖了哪些方法
5. 添加了哪些方法
6. 方法及其参数的前置/后置条件(有时未列出)
7. ...

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