Подтвердить что ты не робот

Как вы читаете JavaDoc?

Какие инструменты/веб-сайты используются для чтения JavaDocs?

В настоящее время я использую Firefox с 20 + вкладками, открытыми при работе над проектом J2EE, чтобы иметь всю доступную документацию, которая не очень удобна в использовании, слишком много памяти и не поддается поиску.

Что я ожидаю от такого инструмента/веб-сайта:

  • Совокупные JavaDocs из разных мест
  • Прямой доступ к таким типам, как Ctrl + T в Eclipse или аналогичном
  • Полнотекстовый поиск
  • Перекрестная ссылка между всеми выбранными мной библиотеками Java
  • Для инструмента: автономная поддержка
  • Скорость

не обязательно:

  • возможность комментировать вещи
  • поддержка разных версий библиотеки (+ diffing?)
  • Интеграция с IDE

Edit:

Спасибо за ваши ответы. Я знал большинство сайтов, но дал им еще одну попытку. Вот мое мнение:

  • встроенные функции Eclipse/IDE
    • плотно интегрированный
    • автономная/онлайн-поддержка
  • javadoconline.com (больше не поддерживается)
    • работает
    • чистый внешний вид
    • находит совпадения в более чем одной версии api и позволяет легко переключаться
    • простой, но работающий
    • быстро
  • jdocs (offline)
    • кажется очень сложным
    • иногда медленный
    • некоторые недавние версии библиотек, кажется, отсутствуют (Seam 2.0.0, Hibernate Validators), но похоже, что вы можете добавить их сами.
    • Интеграция IDE (не проверена)
    • комментарии в стиле вики к каждому элементу
  • docjar.com
    • работает
    • быстро
    • загроможденный пользовательский интерфейс
  • javadoc_isearch
    • greasemonkey script для firefox, который упрощает навигацию по javadocs
    • работает гладко и отлично
4b9b3361

ОТВЕТЫ

Ответ 1

Если вы используете Eclipse, он предлагает поддержку Javadocs. Например, при наведении указателя мыши на вызов метода отобразится всплывающая подсказка, показывающая вам Javadoc для этого метода. Документация для основных классов Java поддерживается из коробки. Однако, если ваш проект использует любые дополнительные библиотеки (файлы JAR), требуется некоторая конфигурация, чтобы подключить их Javadocs в Eclipse.

  • Перейдите в раздел "Путь сборки Java" в свойствах вашего проекта.
  • Перейдите на вкладку "Библиотеки" и нажмите значок "плюс" рядом с файлом JAR.
  • Нажмите "Местоположение Javadoc", затем кнопку "Изменить...".

Это позволит вам указать, где расположены Javadocs для этого JAR. Он даже позволит вам указать URL-адрес веб-сайта, поэтому вам не нужно загружать Javadocs самостоятельно!

Ответ 3

Вы можете найти JavaDoc Стэнфордского университета здесь.

Ответ 4

Я написал для этого свой собственный инструмент. По мнению моих коллег, их лучше всего видеть.

Он индексирует lucene один раз и запускает вас на небольшом сервере на фоне, поэтому yo просматривайте javadocs (pydocs, perldocs..), как в браузере. Это позволяет также отдельные библиотеки на язык, поэтому поиск таких как "biginteger" или simialr не ошибается.

https://github.com/judovana/JavadocOfflineSearch/releases

Ответ 5

Eclipse хорошо интегрируется с Javadoc и имеет для него HTML-подобный просмотрщик. Вы можете присоединить источник и javadoc к двоичным файлам, которые будут отображаться при выборе класса.

Ответ 7

Лично у меня никогда не было проблем со встроенными инструментами просмотра javadoc, предлагаемыми моей IDE.

В настоящее время я использую IntelliJ Idea - Ctl-Q вызывает javadoc для метода под курсором, а гиперссылки на другие части функциональности документации.

Я бы предположил, что NetBeans и Eclipse предлагают аналогичную функциональность.

Ответ 8

gotapi - отличный сайт для просмотра javadoc, а также множество других документов. Я обычно могу найти то, что я ищу там быстрее, поскольку он добавляет приятную функцию поиска.

Ответ 9

Hm... Как насчет:

  • http://edu.netbeans.org/quicktour/javadoc.html - NetBeans поддерживает стандарт Javadoc для документации Java - как просмотр, так и генерацию.
  • http://globaldocs.zeevbelkin.com/ - это приложение позволяет удобно просматривать через Интернет и локальную файловую систему несколько наборов javadoc, используя отдельные пакеты/классы иерархическое дерево и индекс поиска. Средство просмотра поддерживает локальные и удаленные docset (поддерживаются локальные документы, упакованные в JAR/ZIP файлы).

Я предпочитаю NetBeans, так как он автоматически получает JavaDoc из каталога Maven ~/.m2...

Ответ 10

Этот подключаемый модуль для Firefox и Chrome полезен для быстрого поиска имен пакетов и классов, хотя это не полный текстовый поиск: https://code.google.com/p/javadoc-search-frame/

Ответ 11

Ядро JavaDoc можно распаковывать напрямую. Теоретически любые выпущенные javadocs могут быть загружены и просмотрены в автономном режиме.

  • скачать прямо из репозитория maven. Например: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

  • Теперь вы получите objectify-5.0.3-javadoc.jar, переименуйте файл в objectify-5.0.3-javadoc.zip

  • используйте свой любимый инструмент распаковки, чтобы извлечь его, теперь у вас есть папка objectify-5.0.3-javadoc

  • двойной щелчок index.html откроет страницу индекса в браузере по умолчанию.

Ответ 12

Doxygen (http://www.doxygen.nl/) может отвечать всем требованиям.

РЕДАКТИРОВАТЬ: возможно, я неправильно понял ваш вопрос, doxygen - это инструмент для генерации документации и моделей на основе вашего кода и Javadoc.

Ответ 13

Eclipse - лучший способ увидеть javadocs. Наведите указатель мыши на метод или любое объявление, и вы получите автоматически генерируемые javadocs с помощью eclipse.