Блог

Главная - Вопросы по программированию - Как использовать класс Java на основе документации по его API

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

#java #xml #api #javadoc #carrot2

#java #xml #API #Javadoc #carrot2

Вопрос:

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

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

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

Комментарии:

1. Я получаю Not Found , можете ли вы опубликовать полный URL?

2. Я думаю, что это так: download.carrot2.org/stable/javadoc/org/carrot2/source/xml /…

Ответ №1:

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

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

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

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

Ответ №2:

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

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

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

Ответ №3:

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

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

Ответ №4:

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

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