Как использовать Java-класс на основе его документации API - PullRequest
Новая
       37

Как использовать Java-класс на основе его документации API

0 голосов
/ 11 мая 2011

Я новичок в Java, и мне нужно работать над проектом, требующим использования программного обеспечения с открытым исходным кодом.Я очень запутался в понимании документации по Java API.В качестве примера, можете ли вы показать мне, как использовать связанный Java-класс RemoteXmlSimpleSearchEngineBase, основанный на его Java API.

Пожалуйста, обратитесь по этой ссылке http://download.carrot2.org/stable/javadoc/org/carrot2/source/xml/RemoteXmlSimpleSearchEngineBase.html

Я очень заинтересован в этомпроцесс деривации, так что я могу использовать другие Java-классы на основе чтения его документации API.Спасибо.

Ответы [ 4 ]

2 голосов
/ 11 мая 2011

Часто JavaDoc объясняет не общую концепцию библиотеки, а только API для этого класса. Он может содержать более полезную информацию (как в JDK JavaDocs), но в целом вы должны попытаться получить руководство пользователя, справочник или руководство по началу работы.

Из JavaDoc вы можете узнать несколько вещей:

  1. какие интерфейсы реализованы
  2. которые существуют непосредственно известные подклассы / разработчики
  3. вы видите, что класс абстрактный
  4. какие методы добавляются / переопределяются этим классом
  5. какие методы добавляются
  6. предварительные / постусловия методов и их параметров (иногда не указаны)
  7. ...

Однако вы часто не понимаете общую концепцию или когда вызывается метод, как настроить класс для различных случаев использования и т. Д. Вы просто не можете поместить все это в документацию API.

0 голосов
/ 14 июля 2011

Очень часто на странице обзора JavaDoc есть некоторый обзор API и примеры кода. Это на самом деле имеет место с Carrot2 JavaDoc:

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

0 голосов
/ 12 мая 2011

Когда я пытаюсь получить представление о некоторых API, я часто нахожу полезными деревья классов / интерфейсов и, более того, страницы «Использование» - они показывают, какие другие классы / интерфейсы используют этот класс / интерфейс в своих API. Здесь показано, как получить некоторый тип объекта (путем поиска возвращаемых значений) или что делать с каким-либо объектом (кроме использования его методов).

К сожалению, последние не генерируются по умолчанию (а также отсутствуют в примере в вашем вопросе).

0 голосов
/ 11 мая 2011

Может быть, вам стоит взглянуть на проектную документацию:

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

У вас есть несколько примеров и много информации.

...