redhat-developer / redhat-developer/vscode-java

Allow opening Javadoc in browser

Offen
#1,247 5 Kommentare 12 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement hover
Vorherrschende Sprache
TypeScript
Sterne
2.3k
Forks
546
Ø Merge
20 Std. 1 Min.
Gemergte PRs (30 T.)
11

Beschreibung

I often want to view the Javadoc in the browser for easier reading, or to read package/module documentation (which afaik isn't easily viewable somehow inside VS Code).

Environment
  • Operating System: Windows 10
  • JDK version: 13.0.1
  • Visual Studio Code version: 1.41.1
  • Java extension version: 0.55.1
Steps To Reproduce

option 1:

  1. hover over an element

option 2:

  1. trigger autocompletion for an elemention
Current Result

option 1:
image

option 2:
image

Expected Result

I'd like for the pop-up dialogs to have an icon which opens the Javadoc of the element in the default browser. I'd already be very happy if this would work for just JDK classes, but ideally this would also work for Maven dependencies.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Verwende die im Reproduktionsschritt beschriebenen Dokumentations-Popups für Hover und Vervollständigung als Einstiegspunkte. Prüfe, wie Javadoc für JDK-Klassen und Maven-Abhängigkeiten aufgelöst wird; als erledigt gilt, wenn beide Popups eine Browser-Aktion anbieten, die die relevante Javadoc öffnet, wobei Unterstützung nur für JDK akzeptabel ist, falls Unterstützung für Abhängigkeiten nicht verfügbar ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, vscode
Bereich
developer-experience, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
50/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.