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

如何使用基于API文档的java类,java,xml,api,javadoc,carrot2,Java,Xml,Api,Javadoc,Carrot2,我是Java新手,需要从事一个需要使用开源软件的项目。我对理解这些JavaAPI的文档感到非常困惑。 作为一个例子,您可以告诉我如何使用基于java API的相关java类RemoteXmlSimpleSearchEngineBase 请参考此链接 我对这个派生过程非常感兴趣,因此我可以在阅读其API文档的基础上使用其他java类。谢谢。JavaDoc通常不会解释库的一般概念,而只是解释该类的API。它可能包含更多有用的信息(如JDK JavaDocs),但一般来说,您应该尝试获取用户手册、参

我是Java新手,需要从事一个需要使用开源软件的项目。我对理解这些JavaAPI的文档感到非常困惑。 作为一个例子,您可以告诉我如何使用基于java API的相关java类RemoteXmlSimpleSearchEngineBase

请参考此链接


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

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

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

  • 实现了哪些接口
  • 存在哪些直接已知的子类/实现者
  • 你可以看到这个类是抽象的
  • 该类添加/重写了哪些方法
  • 添加了哪些方法
  • 方法及其参数的前置/后置条件(有时未列出)

  • 但是,您通常不了解一般概念,或者在调用方法时,如何为各种用例配置类等。您无法将这些内容全部放入API文档中。

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


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

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


    遗憾的是,后一个不是默认生成的(在您的问题的示例中也缺少)。

    通常,JavaDoc概览页面会有一些API和代码示例的概述。胡萝卜2 JavaDoc实际上就是这样:


    我发现一个
    未找到
    ,你能发布完整的url吗?我想是这样的: