it-swarm.xyz

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

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

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

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

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

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

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

Правка:

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

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

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

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

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

9
Michael

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

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

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

2
judovana

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

2
Léo Léopold Hertz 준영

Кувшин JavaDoc можно распаковать напрямую. Теоретически любой выпущенный Javadocs можно скачать и просмотреть в автономном режиме. 

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

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

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

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

2
Max

Я использую http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ для FF. Позволяет мне легко просматривать другие библиотеки.

2
Swati

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

1
Glenn Lawrence

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

1
Heath Borders

Что-то подобное может быть полезным?

http://www.docjar.com/

1
user7094

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

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

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

1
Rob Dickerson

Хм ... Как насчет:

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

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

1
gavenkoa

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

Правка: возможно, я неправильно понял ваш вопрос, doxygen - это инструмент для генерации документации и моделей на основе вашего кода и Javadoc. 

0
mmattax

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

0
Rohit deol