2008-09-16 3 views
28

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

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

То, что я бы ожидать от такого инструмента/веб-сайт:

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

не является обязательным: (? + Сравниваете)

  • возможность аннотирования вещи
  • поддержка различных версий библиотеки
  • IDE интеграция

Edit:

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

  • встроенный в Затмении/IDE функции
    • тесно интегрированы
    • форума/онлайн поддержки
  • javadoconline.com (больше не поддерживается)
    • работы
    • чистый внешний вид
    • находит совпадения в более чем одной версии API и позволяет легко переключаться
    • простой, но работающий
    • быстро
  • jdocs (отсутствует)
    • кажется очень сложным
    • иногда медленно
    • Некоторые последние версии библиотек, кажется, отсутствуют (Seam 2.0.0, Hibernate валидаторы), но похоже, что вы можете добавить их сами
    • IDE интеграции (не проверено)
    • комментарии вики стиль для каждого элемента
  • docjar.com
    • работы
    • быстро
    • загроможденный UI
  • javadoc_isearch
    • Greasemonkey скрипт для Firefox, который делает навигацию Javadocs проще
    • работает гладко и идеально
+0

для «перекрестных ссылок» Кроме этого, NetBeans делает все вещи из первого списка пули (и уже сделал еще в '08) – 2014-07-07 21:45:34

+0

Попробуйте это - http://javasearch.buggybread.com – 2016-02-16 21:26:27

ответ

1

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

0

Doxygen (http://www.stack.nl/~dimitri/doxygen/) может соответствовать счету.

EDIT: Возможно, я неправильно понял ваш вопрос, doxygen - это инструмент для создания документации и моделей, основанных на вашем коде и javadoc.

+0

Вы получили это, но спасибо в любом случае;) – jrudolph 2008-09-16 15:23:24

1

Может быть что-то подобное?

http://www.docjar.com/

+0

Спасибо, да, я знаю это, но мне не нравится поиск, и у него нет панели навигации или что-то в этом роде. Все вместе дизайн для меня не достаточно чист. – jrudolph 2008-09-16 15:22:49

1

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

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

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

+0

+1 Точно. Зачем беспокоиться о дополнительных инструментах или веб-сайтах, когда проще всего читать Javadocs прямо в среде IDE, где вам в основном нужны. (Получите локальные копии документов API (или источников) внешних библиотек, чтобы ускорить их доступ.) – Jonik 2009-04-25 19:59:39

2

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

+0

Это выглядит немного устаревшим. Он все еще работает? – jrudolph 2008-09-16 15:27:21

+0

Да, я тестировал его, и мне это очень нравится. Это быстро и работает так, как должно. Хороший. – jrudolph 2008-09-17 07:26:06

+0

Для Firefox вы можете просто ввести следующее в строке местоположения: `jar: file: // <путь к вашему архиву zip или jar>! /`.Не забывайте о концевой косой черты. Кредиты: http://popqvarnstrom.blogspot.pt/2012/03/browsing-jarzip-files-eg-javadoc-in.html – 2016-01-05 11:15:54

8

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

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

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

+0

Thx для точного объяснения того, как это сделать. Я знал это, но, вероятно, будут другие, которые этого не сделали. – jrudolph 2008-09-17 07:33:52

2

JavaDoc here Стэнфордского университета.

+1

У меня есть 404 для этого, но есть и это: http://www.stanford.edu/class/cs108/JavaDocFast.html Он просто предоставляет несколько хороших быстрых ссылок на doc для встроенных классов Java – MatrixFrog 2009-08-14 18:39:09

1

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

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

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

0

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

1

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

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

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

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

Смежные вопросы