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

【问题标题】：How to use a java class based on its API documentation如何使用基于其 API 文档的 java 类
【发布时间】：2011-08-23 09:23:00
【问题描述】：

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

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

【问题讨论】：

【解决方案1】：

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

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

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

【讨论】：

【解决方案2】：

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

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

【讨论】：

【解决方案3】：

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

遗憾的是，默认情况下不会生成后者（并且在您问题的示例中也缺少）。

【讨论】：

【解决方案4】：

JavaDoc 概览页面通常会提供一些 API 概览和代码示例。这实际上是 Carrot2 JavaDoc 的情况：

【讨论】：