it-roy-ru.com

Как увидеть JavaDoc в IntelliJ IDEA?

Я только что переключился с Eclipse на IntelliJ. В IntelliJ отсутствует одна особенность Eclipse - когда вы наводите указатель мыши на метод, Eclipse отображает информацию javadoc. Я думаю, что способ показать это - использовать ярлык - command+J, но когда я нажимаю на нее, я получаю что-то не так, как на скриншоте ниже. Пожалуйста, сообщите мне, как я могу быстро получить информацию Javadoc. Мне нужно хотя бы знать, какой тип возвращает метод.

enter image description here

401
Eugene

Используйте View | Быстрая документация или соответствующее сочетание клавиш (по умолчанию: Ctrl+Q в Windows/Linux и Ctrl+J на macOS или F1 в последних версиях IDE). Смотрите документация для получения дополнительной информации.

Также возможно включить автоматическое всплывающее окно JavaDoc для явного (вызванного ярлыком) завершения кода в Settings | Editor | General | Code completion ( Документация по автозапуску ):

autopopup documentation

Еще один способ увидеть быстрый документ - это при движении мыши :

on mouse move

562
CrazyCoder

В версии 13.1+ есть настройка для этого

Перейдите к File/Settings, IDE Settings / Editor, затем ✔ Show quick doc on mouse move.

Версия 14.0+:

Перейдите к File/Settings, Editor, нажмите General. Прокрутите вниз, затем ✔ Show quick documentation on mouse move.

enter image description here

128
Martin Wickman

Или вы можете навести курсор на элемент и показать JavaDoc, используя

CTRL+Q

который является ярлыком по умолчанию.

Правка: как Methical упомянул на Mac ярлык

CTRL+j (^+j не +j)

121
Dropout

Есть хорошая функция, которая показывает быструю документацию, когда ваша мышь находится над элементом.

IntelliJ 14

Редактор/Общее -> Показать быструю документацию по перемещению мыши

Старые версии

Добавьте следующую строку в файл idea.properties:

auto.show.quick.doc=true
22
Michal Z m u d a

Конфигурация IntelliJ IDEA CE 2016.3.4 для включения JavaDocs при наведении курсора мыши. Я использую IntelliJ IDEA в Mac OS, но считаю, что Linux/Windows должны иметь аналогичные параметры.

Документы для автозапуска: IntelliJ IDEA> Preferences> Editor> General> Code Completion

enter image description here

Документация по перемещению мыши: IntelliJ IDEA> Preferences> Editor> General

enter image description here

ПРИМЕЧАНИЕ. Нажмите кнопку Применить , чтобы применить эти настройки.

5
realPK

Для наилучшего отражения функциональности Eclipses включите следующие параметры:

  • IDE Settings/Editor -> Другое. Показать быстрый документ при перемещении мыши
  • Настройки IDE/Редактор/Завершение кода -> Документация автозапуска

Чтобы увидеть Javadoc в меню автозаполнения, нажмите "." чтобы получить всплывающее окно, затем наведите курсор мыши на объект, с которым вы работаете, как только вы получите всплывающее окно Javadoc, вы можете выбрать элемент во всплывающем окне, чтобы переключить Javadoc. Не идеально ... Но это что-то.

Как еще одна заметка. Функция поиска в меню параметров очень полезна. Просто введите "doc", и вы увидите все опции для doc.

Кроме того, поиск "autopopup doc" не только найдет каждый из параметров, но и выделит их в меню. Довольно круто!


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

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

Лично Ctrl + Q на окнах не был идеальным, поэтому я переназначил его на Alt + D. Преобразование может быть выполнено в IDE Настройки/Карта ключей. Оказавшись в меню раскладки клавиатуры, просто найдите Quick Documentation.

5
J.D.

Перейдите в Настройки -> Редактор -> Общие, затем включите Показать быструю документацию по перемещению мыши

4
Vork

IntelliJ IDEA 15 добавил эту функцию

Теперь он доступен как EAP.

Как вы можете видеть на рисунке ниже, положение каретки не влияет на положение курсора: enter image description here

Эта функция была реализована в IntelliJ IDEA 15 142.4675.3 Замечания к выпуску .

4
ROMANIA_engineer

Для меня это было не только открытие окна Javadoc, но и получение полного Javadoc для представления. Вы все еще можете получить разреженный javadoc, который основан исключительно на сигнатуре метода, если вы импортируете библиотеки из репозитория Maven и не говорите Idea о включении javadocs в загрузку. Обязательно установите флажок "JavaDocs" в диалоговом окне "Загрузить библиотеку из репозитория Maven", которое можно найти в разделе "Структура проекта" -> "Параметры проекта ->" Библиотеки ".

3
Craig Lowery

Ближайшим к Eclipse будет Ctrl + Button2 Click (Scroll click)

Он называется Quick Doc в IntelliJ, я хочу, чтобы ребята из JetBrains однажды добавили быстрый документ, такой как Eclipse, с помощью Ctrl + Mouse Move это намного лучше.

В моем случае только с одним движением мыши это немного раздражает, поэтому, если вы ищете в Preferences/Settings -> Keymap "быстрая документация", вы найдете:

  • Win-Linux: " Ctrl + Q " и " Ctrl + Button2 Нажмите "(Нажмите прокрутку)
  • Mac: " Ctrl + J " и " Ctrl + Button2 Нажмите " (Прокрутка нажмите)
2
r1ckr

Я заметил, что выбор имени метода и нажатие F2 (Quick Documentation) выводит на экран его JavaDoc. Я использую Intellij 2016 и Eclipse Keymap

1
razvang