So starten Sie die API-Dokumentation im Browser von IntelliJ IDEA aus

2458
user4955663

Ich habe gerade IntelliJ IDEA heruntergeladen und versucht, etwas Nützliches damit zu tun. Ich benutze das Scala-Plugin. Es scheint, dass IntelliJ alle in build.sbt-Projektabhängigkeiten erwähnten Bibliotheken + Javadocs herunterlädt.

Wie kann ich eine browserbasierte API-Dokumentation von IntelliJ aus starten? Ich suche nach einer Möglichkeit, alle Klassen in einer API anzuzeigen.

Beispiel:

Ich verwende die scalajs-dom-Bibliothek in meinem Projekt. Dann möchte ich folgende Dokumentation (die IntelliJ bereits in mein System heruntergeladen hat) von irgendwo in der IntelliJ-IDEA starten: http://www.scala-js.org/api/scalajs-dom/0.9.0/#org. scalajs.dom.package

Meiner Meinung nach ist dies ein guter Ort für das Starten von Projektfenster / externen Bibliotheken / scalajs-dom, aber es ist nicht vorhanden.

Ein anderer guter Ort könnte im Editor sein. Wann immer Sie auf eine Klasse zeigen, die zur Bibliothek scala.js gehört, können Sie aus dem Popup-Menü etwas wie "API-Dokumentation" auswählen, aber es ist auch nicht vorhanden.

BEARBEITEN: IntelliJ IDEA-Hilfe zu externen Dokumenten: https://www.jetbrains.com/idea/help/viewing-external-documentation.html

  • In meiner IDEA (Community Edition V15.0.4) befindet sich im Menü Ansicht kein externer Dokumentationsbefehl
  • Das Drücken von Shift + F1 bewirkt nichts, selbst wenn eine Klasse mit Javadoc ausgewählt ist
  • Der Pfeil nach oben (= externe Dokumentation anzeigen) des Schnelldokumentationsfensters ist immer deaktiviert

Wählen Sie in Projektfenster / externen Bibliotheken jedoch eine Bibliothek aus und öffnen Sie dann die Bibliothekseinstellungen. Ich sehe, dass es Bibliotheken, Quellen und Javadocs gibt.

Das schnelle Dokumentationsfenster funktioniert gut.

EDIT2: Wenn ich Strg + Umschalt + A drücke, öffnet sich der Dialog "Aktion oder Optionsname eingeben". Externe Dokumentation ist vorhanden, aber grau, ich kann sie nicht auswählen oder damit etwas anfangen.

3
Wenn Sie eine Referenz markieren und F1 drücken, wird ein Dokumentbetrachter mit kontextabhängiger Hilfe gestartet? Die meisten IDEs, die ich im Laufe der Jahre verwendet habe, verwenden F1, einschließlich Eclipse und Visual Studio. Anscheinend gilt dies auch für IDEA: http://stackoverflow.com/questions/12840963/how-to-disable-help-in-intellij-idea. Navigieren Sie im Doc-Browser einfach zur Paketebene für die API. Frank Thomas vor 8 Jahren 0
Beim Zeigen verschiedener Dinge und Drücken von F1 erhalte ich diese: Externe lib: https://www.jetbrains.com/idea/help/project-tool-window.html Klasse im Editor: https://www.jetbrains.com/idea /help/intellij-idea-editor.html Doc-Fenster: https://www.jetbrains.com/idea/help/documentation-tool-window.html Verschiedene allgemeine Hilfen helfen jedoch nicht dem API-Dokument. user4955663 vor 8 Jahren 0
https://www.jetbrains.com/idea/help/viewing-external-documentation.html CrazyCoder vor 8 Jahren 0
Ich habe Ihren Kommentar überprüft und die Frage bearbeitet. user4955663 vor 8 Jahren 0

2 Antworten auf die Frage

1
Bazi

Der einzige Grund für View External Documentationdie Deaktivierung ist, dass IDEA die Javadoc-Datei für Ihre Klassen nicht finden kann. Sie müssen sicherstellen, dass für jede Abhängigkeit, für die Sie die Dokumentation in einem externen Viewer anzeigen möchten, Javadoc-Dateien vorhanden sind.

In IDEA können Sie mit der rechten Maustaste auf das Projekt klicken und auswählen Maven -> Download Documentation, dass alle Javadoc-Dateien für Abhängigkeiten vorhanden sind.

Hier ist eine weitere SO-Frage, die zeigt, wie Javadocs an ausgewählte Abhängigkeiten angehängt werden

0
Anton Dozortsev

Versuchen Sie, die Aktion External Documentationmit der Suchfunktion Ctrl+ Shift+ zu finden A. Es muss in sein Code View Actions.

So aktiviert, Quick Documentationindem Shift+ F1gehen Projektstruktur und hier in SDKsauf Documentation PathsRegisterkarte URL angeben, klicken Sie auf und mit der Erde .

Also Quick Documentationmuss jetzt auch funktionieren View external documentation.

Externe Dokumentation in Suchaktion ist grau, ich kann sie nicht auswählen. Die schnelle Dokumentation funktioniert einwandfrei, seit Beginn funktioniert sie einwandfrei. user4955663 vor 8 Jahren 0
@ Haben Sie URL für Java API hinzugefügt? Anton Dozortsev vor 8 Jahren 0
Ich habe zwei Möglichkeiten ausprobiert: die URL und das lokal installierte Javadoc-Verzeichnis. In beiden Fällen war die externe Dokumentation in "Suchaktionen" immer noch grau und nicht im Menü "Ansicht". user4955663 vor 8 Jahren 0
@ user4955663 Funktioniert für die IntelliJ Ultimatum Edition Anton Dozortsev vor 8 Jahren 0

Verwandte Probleme