Как просматривать JavaDoc в IntelliJ IDEA
Часто разработчики, особенно новички, сталкиваются с проблемой просмотра JavaDoc в IntelliJ IDEA. Многие переходят с Eclipse, где при наведении мыши на метод отображается информация JavaDoc. В IntelliJ IDEA функционал может казаться несколько отличным, но на самом деле доступ к JavaDoc там также прост и удобен.
Возможности просмотра JavaDoc в IntelliJ IDEA
Во-первых, в IntelliJ IDEA есть возможность просмотра JavaDoc в отдельной панели. Для этого нужно зайти в меню View -> Tool Windows -> JavaDoc . Это откроет панель JavaDoc, где можно просмотреть документацию для выбранного метода или класса.
Использование горячих клавиш
Также можно использовать горячие клавиши для быстрого доступа к JavaDoc. Для этого нужно нажать Ctrl + Q (или Command + J на Mac). Это откроет всплывающее окно с JavaDoc для выделенного метода или класса.
Решение проблемы с некорректным отображением JavaDoc
Если при попытке открыть JavaDoc отображается некорректная информация или возникает какая-то ошибка, то возможно, что в проекте не настроены JDK или библиотеки. Для решения этой проблемы нужно проверить и, при необходимости, настроить JDK и библиотеки в настройках проекта. Для этого нужно зайти в File -> Project Structure -> SDKs и убедиться, что установлено правильное JDK и все нужные библиотеки.
Таким образом, просмотр JavaDoc в IntelliJ IDEA не так сложен, как может показаться на первый взгляд. С помощью горячих клавиш или специальной панели можно быстро и удобно получить доступ к документации для нужного метода или класса.
Как увидеть JavaDoc в IntelliJ IDEA? [Дубликат]
Я только что переключился с Eclipse на IntelliJ. В IntelliJ отсутствует одна особенность Eclipse — когда вы наводите указатель мыши на метод, Eclipse отображает информацию javadoc. Я думаю, что способ показать это — использовать ярлык — command + J , но когда я нажимаю на него, я получаю что-то не так, как на скриншоте ниже. Пожалуйста, сообщите мне, как я могу быстро получить информацию Javadoc. Мне нужно хотя бы знать, какой тип возвращает метод.
Eugene 15 июнь 2012, в 17:42
Поделиться
Поделиться:
intellij-idea
11 ответов
Лучший ответ
Использовать View | Быстрая документация или соответствующее сочетание клавиш (по умолчанию: Ctrl + Q в Windows/Linux и Ctrl + J в macOS или F1 в последних версиях IDE). Смотрите документацию для получения дополнительной информации. Также возможно включить автоматическое всплывающее окно JavaDoc при явном (вызванном ярлыком) завершении кода в Settings | Editor | General | Code completion (документация Автопопа): 
Еще один способ увидеть быстрый документ — это движение мыши: 
CrazyCoder 15 июнь 2012, в 16:00
Поделиться
+1, не удалось найти Preferences в IntelliJ Idea CE для Android.
Gaurav Agarwal 06 сен. 2012, в 03:56
Win7 = позиционировать курсор перед классом -> CTRL + q
Eddie B 12 дек. 2012, в 20:33
Я был достаточно глуп, чтобы следовать приведенному выше совету на Mac. Cmd + Q. Boom! Выйти IntelliJ. Genius ..
Siddhartha 06 сен. 2013, в 01:51
Это CTRL + J на Mac.
methical 03 янв. 2014, в 12:41
Когда я делаю это для String.compareToIgnoreCase (), я вижу только подпись, а не объяснение результата. Нужно ли менять настройку, чтобы использовать полный JavaDoc?
David W 22 янв. 2014, в 15:20
Фактически, замените Preferences File | Settings (v 13.1)
Guillaume Husta 13 май 2014, в 12:45
@GuillaumeHusta зависит от операционной системы, Preferences Mac, Settings Windows / Linux.
CrazyCoder 13 май 2014, в 12:46
@CrazyCoder ОК! Спасибо за точность. Странно иметь разные ярлыки в зависимости от ОС. Но это действительно так на официальной онлайн-странице справки: jetbrains.com/idea/webhelp/settings-preferences-dialog.html !
Guillaume Husta 13 май 2014, в 13:17
Ctrl + q работает и на GNU / Linux
Amr Mostafa 31 июль 2014, в 11:37
В 14.0.2 это Файл | Настройки | Редактор | Генерал | Завершение кода
James Wierzba 13 март 2015, в 16:20
«Autopopup» (при наведении курсора мыши) открывает совершенно новое окно (которое захватывает фокус), а не временное наложение, которое исчезает, когда пользователь перемещает мышь или щелкает за пределами окна. Это больше разрушительно, чем полезно — так что одна из тех немногих последних вещей, которые мне не хватает в Eclipse. Я рад узнать о Ctrl-Q (который также закрывает окно). Очень полезно!
Lambart 11 июль 2015, в 06:49
и я думал, что intelliJ лучше, чем Eclipse по всем аспектам.
Thariq Nugrohotomo 23 июнь 2016, в 06:30
Вы пробовали NetBeans? Затмение худшее. Но IntelliJ тоже плохо сосет. NetBeans — это то, что раздражает меня меньше всего. Кроме того, я не понимаю, почему этот ответ одобрен. Вопрос заключался в том, как заставить всплывающее окно появляться при наведении мыши.
Martin Andersson 09 июль 2016, в 14:41
Предложение «Также возможно включить автоматическое всплывающее окно JavaDoc при завершении кода в« Предпочтениях »|« Редактор | Общие | Завершение кода (документация по автопопапу) »не работает. То есть «Для явно вызванного завершения», а не случайное наведение. Реальное исправление заключается в ответе ниже: «Перейдите в« Файл / Настройки »,« Редактор », нажмите« Общие ». Прокрутите вниз, затем ✔ Показать быструю документацию по перемещению мыши».
Jake Toronto 06 фев. 2017, в 18:33
проголосовал за трюк с движением мыши . до сих пор я использовал cntl+j на mac . вы круты @CrazyCoder
Amit Khandelwal 03 март 2017, в 19:23
К сожалению, IDEA не включает его по умолчанию. Ваше меню настроек может отличаться в зависимости от вашей редакции — Community или Professional. Панель поиска в настройках поможет.
realPK 06 март 2017, в 00:59
Ярлык для macOS с IntelliJ 2017 EAP теперь F1 для быстрой документации и Shift+F1 для внешней документации (веб-браузер).
Basil Bourque 13 март 2017, в 01:58
Не уверен, как люди используют ctrl + j в реальной жизни. Эти клавиши слишком далеко на клавиатуре.
RandomQuestion 17 апр. 2017, в 20:12
Может кто-нибудь объяснить использование «Документация Autopopup . » в дополнении кода?
Andrew Kirna 12 окт. 2017, в 20:27
@AndrewKirna, когда вы вызываете завершение кода с помощью сочетания клавиш (против автоматического), IDE покажет вам всплывающую документацию для метода / класса, который вы пытаетесь завершить.
CrazyCoder 13 окт. 2017, в 13:09
Если у вас есть открытый класс с Javadocs, fn + F2 появится во всплывающем окне. Проверено на Mac и IDEA 2017.3.
Abhijit Sarkar 27 дек. 2017, в 20:43
Показать ещё 19 комментариев
В версии 13.1+ есть параметр для этого
Перейдите к File/Settings , IDE Settings / Editor , затем Show quick doc on mouse move .
Перейдите к File/Settings , Editor , нажмите General . Прокрутите вниз, затем Show quick documentation on mouse move .
Martin Wickman 31 март 2014, в 11:22
Поделиться
Хорошо, с этим советом у нас точно такое же поведение, как и с Eclipse (при наведении мыши)
Guillaume Husta 13 май 2014, в 12:51
Функция добавлена с версии 13.0. См. Jetbrains.com/idea/webhelp/editor.html
Guillaume Husta 13 май 2014, в 13:24
На Mac замените Файл / Настройки на IntelliJ / Настройки
darKoram 22 май 2014, в 15:44
Но особенность ужасна с 14.0. Иногда они мешают вашей способности нажимать на предметы или застревать и никогда не исчезнут.
CorayThan 04 дек. 2014, в 01:19
Вам не нужно расширять группу меню «Редактор». Вы не найдете этот параметр в одной из его записей. Вы должны выбрать «группу» редактора , и она покажет страницу настроек справа, где находится опция.
Matthias Ronge 16 фев. 2015, в 08:30
Это действительно замена подмены для поведения мыши при затмении, и очень жаль, что это не основной ответ в этой теме. 🙁
CasualT 26 июнь 2015, в 20:24
Показать ещё 4 комментария
В качестве альтернативы вы можете поместить курсор на элемент и показать JavaDoc с помощью
который является ярлыком по умолчанию.
Изменить: Как упоминалось в Macical, ярлык
Dropout 18 сен. 2013, в 10:15
Поделиться
это работает как то, как eclipse проверяет документацию, а не как голосование с самым высоким рейтингом. Спасибо!
Mohith Maratt 27 май 2016, в 15:29
В Mac F1 работает равным Ctrl + J, чтобы показать JavaDoc
jfuentes 23 июль 2016, в 19:29
Есть хорошая функция, которая показывает быструю документацию, когда мышь находится над элементом.
IntelliJ 14
Редактор/Общее → Показать оперативную документацию по перемещению мыши
Старые версии
Добавьте в файл idea.properties следующую строку:
auto.show.quick.doc=true Michal Z m u d a 11 нояб. 2013, в 14:56
Поделиться
Конфигурация для IntelliJ IDEA CE 2016.3.4 для включения JavaDocs при наведении мыши. Я использую IntelliJ IDEA в Mac OS, но считаю, что Linux/Windows должны иметь аналогичные параметры.
Документы Autopopup: IntelliJ IDEA > Preferences > Editor > General > Code Completion
Документация по перемещению мыши: IntelliJ IDEA > Preferences > Editor > General
ПРИМЕЧАНИЕ. Чтобы применить эти настройки, нажмите кнопку » Применить».
realPK 06 март 2017, в 01:49
Поделиться
Чтобы улучшить функциональность зеркальных затмений, включите следующие настройки:
- Параметры/редактор IDE → Другое. Показ быстрого документа по перемещению мыши
- Параметры IDE/Редактор/Завершение кода → Документация по автоопределению
Чтобы увидеть javadoc в меню автозаполнения, нажмите «.». чтобы получить всплывающее окно, затем наведите указатель мыши на объект, с которым вы работаете, после того как вы получите всплывающее окно javadoc, вы можете выбрать элемент во всплывающем меню, чтобы переключить javadoc. Не идеально. Но это что-то.
В качестве еще одной заметки. Функциональность поиска в меню параметров очень полезна. Просто введите «doc», и вы увидите все параметры документа.
Кроме того, поиск «autopopup doc» не только найдет каждый из параметров, но также отобразит их в меню. Довольно удивительный!
Edit: Исходя из первоначального вопроса, это может быть полезно для людей, которым просто нужен быстрый и легкий доступ к документам.
После использования этого в течение нескольких дней кажется, что просто привыкание использовать горячую клавишу является наиболее эффективным способом. Он выведет документацию на что-нибудь в месте, где ваш маркер ввода текста так вам не нужно прикасаться к мыши. Это также работает во всплывающем окне intellisense и будет оставаться включенным при навигации вверх и вниз.
Лично, Ctrl + Q на окнах не было идеальным, поэтому я переназначил его на Alt + D. Реорганизация может быть выполнена в настройках IDE/Keymap. Как только в меню раскладки клавиатуры просто выполните поиск быстрой документации.
Зачем дьявол придумал javadoc
Есть мнение, что хорошая программа должна быть хорошо задокументирована.
Компания SUN даже придумала специальный формат javadoc — «стандарт для документирования классов Java». В моей практике было совершенно обычным явлением, когда какой-то код не проходил Code Review, потому что в нём у некоторых методов отсутствовали комментарии.
Я утверждаю, что этот подход устарел, и сегодня я расскажу, почему комментарии — это зло.
Пример из жизни
Это реальный код, написанный в 2010 году вполне старательным программистом, который не поленился и написал комментарий к своему методу. Довольный собой, но пошёл налить себе чашечку кофе из аппарата, а мы давайте-ка пока посмотрим, что же тут у нас есть.
public class AddressUtil /**
* Format string as address , expected input
* format:»EE ; ;Tallinn;Narva mnt;120B;831;10127″
*
* @param flatAddress
* @return Formatted address
*/
public static String toString(String flatAddress) <. >
>
Отлично! У нас есть корректно оформленный комментарий в формате javadoc, из которого специальная программа сможет сгенерировать HTML-документацию. По нему легко можно понять, что (теоретически) делает этот метод.
Где же спрятался дьявол?
- Очень скоро эта документация устареет, потому что придёт другой девелопер и поменяет код, но забудет поменять документацию. Это может быть даже тот же самый девелопер, потому что пока он стоял в очереди за кофе, ему пришло в голову, что он забыл обработать один редкий случай. Вернувшись, он добавит нужный IF в код, но забудет о том, что у него уже есть javadoc, который необходимо поддерживать.
- В документации не описаны масса случаев: как поведёт себя метод, если на входе придёт null или пустая строка? Что, если в адресе есть номер дома, но нет номера квартиры (то есть буржуй занял дом целиком)? Что там за пустой параметр между «EE» и «Tallinn»?
- В документации нет ни слова о том, что этот метод возвращает.
- В документации есть целых три лишних строчки: «*», «@param flatAddress» и «@return Formatted address». Только подумайте: они занимают большую часть документации, и они абсолютно бесполезны!
Волшебство
- Пасс номер 1: Всё, что написано красным цветом , превращаем в название метода: toString -> formatAddress.
- Пасс номер 2: Всё, что написано синим цветом , переносим в юнит-тест.
- Пасс номер 3: (мой любимый) Весь текст, написанный зелёным цветом — … правильно, стираем. Навсегда. Не жалейте его, он зря появился на свет!
public class AddressUtil public static String formatAddress (String flatAddress)
@Test public void testFormatAddress() assertEquals(«Narva mnt 120B-831 10127 Tallinn»,
AddressUtil.formatAddress(«EE ; ;Tallinn;Narva mnt;120B;831;10127»));
>
>
- Он тупо КОРОЧЕ: было 8 строк, стало 4.
- Этот тест никогда не устареет, т.к. он будет запускаться автоматически каждый раз при сборке проекта, и если программист поменяет код, а о методе забудет, это сразу всплывёт.
- Можно описать все редкие случаи: пустые строки, отсутствующие параметры, недопустимые значения и т.д.
Одним словом,
ХОРОШЕЕ НАЗВАНИЕ + ТЕСТЫ = ДОКУМЕНТАЦИЯ
а точнее, «запускаемая документация» (executable documentation), то есть документация, которую можно не просто читать, но ещё и «запускать», автоматически проверяя, что она всё ещё адекватна.
Говорят, у Конфуция над кроватью висел плакат:
Convert comments to executable documentation
Послесловие
Боюсь только, что наш доблестный программист, вернувшись с кухни, фокуса не поймёт, ведь он не видел наших волшебных движений. Ему снесёт башню от одного только факта, что его комментарии КТО-ТО НАГЛО ПОТЁР, и он постарается нас найти и уничтожить за такую подрывную деятельность. А его кофе тем временем остынет. Ну что ж, и то неплохо: ведь кофе, говорят, вреден. Значит, одно хорошее дело мы всё-таки сегодня сделали.
UPDATE
В комментариях посыпалась куча возмущений по поводу того, что неудобно использовать open-source библиотеки без документации. Эта статься не о коде, идущем на экспорт. Она о «внутреннем» коде, который пишите вы и ваши коллеги, и использовать будете только вы и ваши коллеги, и который вам предстоит ещё менять неоднократно. В «экспортном» коде всё по-другому — там документация безусловно нужна, но за её за состоянием требуется отдельно следить. Её вам не потребуется менять, а только читать. Это совсем другая история.
Вопросы с меткой [javadoc]
Javadoc — расширяемая система генерации документации в HTML-формате на основе специально отформатированных комментариев в исходном Java коде.
18 вопросов
Конкурсные
Неотвеченные
- Конкурсные 0
- Неотвеченные
- Цитируемые
- Рейтинг
- Неотвеченные (мои метки)
103 показа
javadoc в многомодульном проекте maven
Всем привет. У меня есть многомодульный проект maven, в котором есть модуль api, для которого мне нужно сгенерировать javadoc. Как я могу сгенерировать javadoc не в папку target в модуле api, а в .
задан 21 янв 2021 в 15:37
413 показов
Java conventions, комментирование
Мне непонятен этот пункт: Block comments can start with /*-, which is recognized by indent(1) as the beginning of a block comment that should not reformatted. Example: /* * Here is a block comment .
задан 30 ноя 2020 в 16:53
Как оформить в javadoc передачу изменяемого обьекта
В метод передаются объекты с данными, и объекты в которые записывается ответ. Пока записал как * @param nu = # of user * @param nr = # of ref . * @param @return iu = # user .
задан 17 янв 2019 в 13:02
97 показов
Каким описать сложные формулы в комментариях?
Каким способом можно описать сложные формулы в комментариях?
задан 13 дек 2018 в 1:23
169 показов
Исправить коды \u в html-файлах (javadoc из NetBeans)
Покопавшись в интернете нашёл причину кодов \u**** в html-файлах, получающихся при создании документации html из javadoc-комментариев, записанных в исходном коде файлов *.java: Unicode in javadoc and .
задан 20 авг 2018 в 11:44
50 показов
inheritDoc: Cannot find declaraion to go to
Я создала комментарий к методу в интерфейсе, а в комментарии к методу класса, реализующего интерфейс, использовала @inheritDoc. Но почему-то Intellij Idea не может найти комментарий в интерфейсе, .
задан 18 авг 2017 в 9:16
Комментирование методов
Допустим, есть класс, реализующий некий интерфейс. Где лучше писать комментарии к методам: в классе или в интерфейсе, или же и там, и там? Есть ли какие-либо рекомендации по этому поводу?
задан 17 авг 2017 в 16:49
653 показа
Игнорирование «Missing a Javadoc comment» в IntellijIdea Checkstyle
Какое правило в sun_checks.xml нужно добавить, чтобы игнорировалaсь ошибка Missing a javadoc comment в Checkstyle?
задан 6 июн 2017 в 8:50
167 показов
Исходный код в документации
Можно ли в Javadoc указывать ссылку на исходный код классов и методов, чтобы не нужно было каждый раз искать по каталогам нужный файл? Если да, то как это сделать? Вот пример для Python: .
задан 15 мар 2017 в 18:27
182 показа
Помогите написать java doc для класса
Есть написанный класс дженерик адаптер public abstract class CustomAdapter
задан 27 фев 2017 в 9:05
150 показов
Вопрос по JAVADOC Comments в IntelliJ IDEA
Хочу чтобы IntelliJ IDEA автоматически генерировала при создании в пределах одного проекта коммментарии в шапке каждого нового класса/интерфейса примерно следующего вида: /** * * @date: YYYY/MM/DD (.
задан 18 фев 2017 в 9:44
387 показов
Использование @hide в javadoc
Не раз встречался с аннотацией @hide в Javadoc. Известно что эта аннотация запрещает доступ к методу после релиза (доступ всё так же можно получить через рефлексию). У меня появилась необходимость .
задан 14 фев 2017 в 13:33
148 показов
Android Library различия -source и -javadocs артефактов
Написал библиотеку, выложил в jcenter, подцепил и заметил алерт который меня напрягает: Ни в одной библиотеке, которую я использовал до этого не было такого алерта, следовательно — я где-то накосячил .
задан 7 фев 2017 в 13:48
В IDEA в Maven проектах не отображается документация
У IDEA, как и многих других сред программирования, есть замечательная функция (включается опционально), которая отображает документацию при наведении курсора на класс, метод интерфейс или т.д. Но .
задан 31 июл 2016 в 14:39
Javadoc для Java 8 не работает
Есть проект с фичами Java 8, компилируется, исполняется как надо. Работаю в Eclipse, Mac OS. Но вот при генерации Javadoc вылезает много ошибок вроде таких: illegal start of expression .map((num)-&.
задан 14 июн 2016 в 20:44
15 30 50 на странице
-
Важное на Мете
Связанные метки
Подписаться на ленту
Лента новых вопросов с меткой [javadoc]
Для подписки на ленту скопируйте и вставьте эту ссылку в вашу программу для чтения RSS.
Дизайн сайта / логотип © 2024 Stack Exchange Inc; пользовательские материалы лицензированы в соответствии с CC BY-SA . rev 2024.1.3.2953
Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.