0

私はJavaにまったく慣れていないので、オープンソースソフトウェアの使用を必要とするプロジェクトに取り組む必要があります。私はそれらのJavaAPIのドキュメントを理解することについて非常に混乱しています。例として、JavaAPIに基づいて関連するJavaクラスRemoteXmlSimpleSearchEngineBaseを使用する方法を教えてください。

このリンクを参照してください http://download.carrot2.org/stable/javadoc/org/carrot2/source/xml/RemoteXmlSimpleSearchEngineBase.html

私はこの派生プロセスに非常に興味があり、APIドキュメントを読んで他のJavaクラスを使用できるようにしています。ありがとう。

4

4 に答える 4

2

多くの場合、JavaDoc はライブラリの一般的な概念を説明せず、そのクラスの API のみを説明しています。(JDK JavaDocs のように) より有用な情報が含まれている場合もありますが、一般的には、ユーザー マニュアル、リファレンス、または入門ガイドを入手するようにしてください。

JavaDoc から、いくつかのことを学ぶことができます。

  1. どのインターフェースが実装されているか
  2. 直接知られているサブクラス/実装者が存在する
  3. クラスが抽象であることがわかります
  4. そのクラスによってどのメソッドが追加/オーバーライドされるか
  5. 追加されるメソッド
  6. メソッドとそのパラメーターの事前/事後条件 (リストされていない場合もあります)
  7. ...

ただし、一般的な概念や、メソッドが呼び出されたとき、さまざまなユースケースに合わせてクラスを構成する方法などを理解していないことがよくあります。それらすべてを API ドキュメントに入れることはできません。

于 2011-05-11T14:43:36.107 に答える
0

たぶん、プロジェクトのドキュメントを見る必要があります。

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

あなたはいくつかの例とたくさんの情報を持っています。

于 2011-05-11T15:01:13.997 に答える
0

多くの場合、JavaDoc の概要ページには、API とコード例の概要が記載されています。これは実際に Carrot2 JavaDoc の場合です。

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

于 2011-07-14T10:42:01.093 に答える
0

一部の API の概要を取得しようとするときに役立つことがよくあるのは、クラス/インターフェイス ツリーです。さらに「使用法」ページもあります。これらのページには、API でこのクラス/インターフェイスを使用している他のクラス/インターフェイスが表示されます。これは、(戻り値を見つけることによって) あるタイプのオブジェクトを取得する方法、またはあるオブジェクトをどうするか (そのメソッド自体を使用することを除く) を示しています。

悲しいことに、後者はデフォルトでは生成されません（また、質問の例にもありません）。

于 2011-05-11T21:09:43.903 に答える