Вы ищете в Google Javadoc? Разве это не раздражает? Представьте себе следующее: вы находитесь в состоянии потока, у вас на уме полный стек и добрая пара десятков бизнес-концепций, и вы просто хотите перепроверить поведение данного библиотечного метода. Вы действительно хотите прекратить то, что делаете, открыть браузер, выполнить поиск документации библиотеки, убедиться, что вы ищете правильную версию, а затем перейти к соответствующему классу и методу?
Ты не должен этого делать!
Вот два быстрых и простых способа добавить Javadoc в IntelliJ, чтобы вы могли увидеть его с помощью функции “Быстрая документация”: просто наведите курсор мыши на любой фрагмент кода или используйте комбинацию клавиш быстрой документации, Ctrl+Q для Linux или Windows и F1 на macOS!
Теперь перейдем к первому способу.
Использование Maven
В проектах Maven запустите фазу зависимость: разрешение с помощью классификатора=javadoc , и IntelliJ автоматически получит суперспособности документации.
Есть два способа выполнить это. Во-первых, вы можете выполнить следующую команду Maven с терминала внутри корневого каталога проекта:
$ mvn dependency:resolve -Dclassifier=javadoc
Вы также можете запустить его из окна “Выполнить цель Maven”, которое появляется, когда вы открываете окно инструментов Maven (Вид > Окна инструментов > Maven) и нажимаете значок “M”.
Если вы хотите, вы даже можете сказать Maven всегда загружать Javadoc, когда он доступен. Перейдите в раздел Настройки > Сборка, Выполнение, Развертывание > Инструменты сборки > Maven> Импортируйте и установите флажок Автоматически загружать документацию.
С помощью URL-адреса или файла Jar
У вас есть URL-адрес какого-нибудь Javadoc в Интернете? Затем откройте Структуру проекта, перейдите в раздел Библиотеки и щелкните значок, который сочетает в себе “+” и глобус.
Вставьте URL-адрес и сохраните его.
Если вместо этого у вас есть javadoc в файле jar, вы можете использовать обычный значок “+”, который вы видите в том же окне Структура проекта > Библиотеки.
Как это выглядит
При наличии любой из этих настроек вы можете просто навести курсор мыши на любой фрагмент кода и увидеть полученный Javadoc.
Вывод
С помощью Javadoc, находящегося всего в одном наведении курсора мыши, вы можете сосредоточиться на текущей задаче, а не нарушать свой поток и отправляться в погоню за дикими гусями.
Фото Мириам Эспасио из пикселей
Оригинал: “https://dev.to/scottshipp/two-ways-to-integrate-javadoc-into-intellij-idea-leb”