it-swarm.com.de

Wie wird JavaDoc in IntelliJ IDEA angezeigt?

Ich bin gerade von Eclipse zu IntelliJ gewechselt. In IntelliJ fehlt eine Funktion von Eclipse: Wenn Sie mit der Maus über eine Methode fahren, zeigt Eclipse Javadoc-Informationen an. Ich denke, die Art und Weise zu zeigen, ist eine Verknüpfung zu verwenden - command+J, aber wenn ich darauf klicke, ist etwas nicht in Ordnung, wie in der Abbildung unten dargestellt. Bitte teilen Sie mir mit, wie ich schnell Javadoc-Informationen erhalten kann. Ich muss mindestens wissen, welchen Typ eine Methode zurückgibt.

enter image description here

420
Eugene

Verwenden Sie View | Schnelldokumentation oder die entsprechende Tastenkombination (standardmäßig: Ctrl+Q unter Windows/Linux und Ctrl+J auf macOS oder F1 in den letzten IDE Versionen). Weitere Informationen finden Sie in der Dokumentation .

Es ist auch möglich, das automatische JavaDoc-Popup bei expliziter (durch eine Verknüpfung aufgerufener) Codevervollständigung in Settings | zu aktivieren Editor | General | Code completion ( Autopopup-Dokumentation ):

autopopup documentation

Ein weiterer Weg, um das Schnelldokument zu sehen, ist mit der Maus :

on mouse move

591
CrazyCoder

In Version 13.1+ gibt es dafür eine Einstellung

Gehen Sie zu File/Settings, IDE Settings / Editor und dann zu ✔ Show quick doc on mouse move.

Version 14.0+:

Gehen Sie zu File/Settings, Editor und klicken Sie auf General. Scrollen Sie nach unten und dann ✔ Show quick documentation on mouse move.

enter image description here

131
Martin Wickman

Alternativ können Sie den Cursor auf dem Objekt positionieren und JavaDoc mit anzeigen

CTRL+Q

dies ist die Standardverknüpfung.

Edit: Wie Methical schon sagte auf Mac die Abkürzung ist

CTRL+j (^+j nicht +j)

124
Dropout

Es gibt eine nette Funktion, die eine schnelle Dokumentation anzeigt, wenn sich Ihre Maus über dem Element befindet.

IntelliJ 14

Editor/Allgemein -> Schnelle Dokumentation zum Bewegen der Maus anzeigen

ältere Versionen

Fügen Sie der Datei idea.properties die folgende Zeile hinzu:

auto.show.quick.doc=true
22

Konfiguration für IntelliJ IDEA CE 2016.3.4 zum Aktivieren von JavaDocs beim Bewegen der Maus. Ich verwende IntelliJ IDEA unter Mac OS, bin jedoch der Meinung, dass Linux/Windows ähnliche Optionen haben sollte.

Autopopup-Dokumente: IntelliJ IDEA> Preferences> Editor> General> Code Completion

enter image description here

Dokumentation bei Mausbewegung: IntelliJ IDEA> Preferences> Editor> General

enter image description here

HINWEIS: Klicken Sie auf Übernehmen , um diese Einstellungen zu übernehmen

5
realPK

Aktivieren Sie die folgenden Einstellungen, um die Eclipses-Funktionalität optimal zu spiegeln:

  • IDE Settings/Editor -> Other.Show schnelles Dokument bei Mausbewegung
  • IDE-Einstellungen/Editor/Code-Vervollständigung -> Autopopup-Dokumentation

Um das Javadoc im Autocomplete-Menü anzuzeigen, drücken Sie '.' Um das Popup zu erhalten, bewegen Sie den Mauszeiger über das Objekt, mit dem Sie arbeiten. Sobald Sie das Javadoc-Popup erhalten haben, können Sie ein Element im Popup auswählen, um das Javadoc umzuschalten. Nicht ideal ... aber es ist etwas.

Als weitere Anmerkung. Die Suchfunktion des Optionsmenüs ist sehr hilfreich. Geben Sie einfach 'doc' ein und Sie werden alle Optionen für doc sehen.

Wenn Sie nach "autopopup doc" suchen, werden nicht nur alle Optionen gefunden, sondern auch im Menü hervorgehoben. Ziemlich cool!


Edit: Über die ursprüngliche Frage hinaus kann dies hilfreich sein für Personen, die nur einen schnellen und einfachen Zugriff auf die Dokumente wünschen.

Nach ein paar Tagen scheint es am effizientesten zu sein, sich nur an die Verwendung des Hotkeys zu gewöhnen. An der Stelle, an der sich Ihre Texteingabemarkierung befindet, wird die Dokumentation für alles eingeblendet, sodass Sie niemals die Maus berühren müssen. Dies funktioniert auch im Intellisense-Popup und bleibt während der Navigation nach oben und unten aktiv.

Persönlich war Strg + Q unter Windows nicht ideal, also habe ich es Alt + D zugeordnet. Das Remaping kann unter IDE Settings/Keymap durchgeführt werden. Suchen Sie im Keymap-Menü nach "Quick Documentation".

5
J.D.

Gehe zu Einstellungen -> Editor -> Allgemein und aktiviere Schnelldokumentation beim Bewegen der Maus anzeigen

4
Vork

IntelliJ IDEA 15 hat diese Funktion hinzugefügt

Jetzt ist es als EAP verfügbar.

Wie Sie in der Abbildung unten sehen können, hat die Position des Einfügemarke keinen Einfluss auf die Cursorposition: enter image description here

Diese Funktion wurde in IntelliJ IDEA 15 142.4675.3 Release Notes implementiert.

4

Für mich war es nicht nur das Öffnen des Javadoc-Fensters, sondern auch das Präsentieren des kompletten Javadocs. Möglicherweise erhalten Sie weiterhin ein spärliches Javadoc, das ausschließlich auf der Methodensignatur basiert, wenn Sie Bibliotheken aus einem Maven-Repository importieren und Idea nicht anweisen, die Javadocs in den Download einzubeziehen. Stellen Sie sicher, dass Sie die Option "JavaDocs" im Dialogfeld "Download Library From Maven Repository" aktivieren, das Sie unter Projektstruktur -> Projekteinstellungen -> Bibliotheken finden.

3
Craig Lowery

Der Eclipse am nächsten liegende Punkt ist Strg + Button2 Klicken (Scroll-Klick)

In IntelliJ heißt es Quick Doc. Ich wünschte, Jungs von JetBrains würden eines Tages Quick Docs wie Eclipse mit Strg + Mausbewegung hinzufügen. Es ist so viel besser.

In meinem Fall ist nur mit nur Mausklick etwas nervig, also wenn Sie in Einstellungen -> Keymap nach "Schnelldokumentation" suchen, finden Sie:

  • Win-Linux: " Ctrl + Q " und " Ctrl + Button2 Click "(Scrollklick)
  • Mac: " Strg + J " und " Strg + Taste2 Klicken " (Scrollklick)
2
r1ckr

Ich habe festgestellt, dass durch Auswahl des Methodennamens und Drücken von F2 (Quick Documentation) JavaDoc angezeigt wird. Ich verwende Intellij 2016 und Eclipse Keymap

1
razvang