redhat-developer / redhat-developer/vscode-java

Allow opening Javadoc in browser

未关闭
#1,247 5 条评论 12 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement hover
主要语言
TypeScript
星标
2.3k
派生
546
平均合并
20 小时 1 分钟
30 天内合并 PR
11

描述

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

使用复现中描述的悬停和补全文档弹窗作为入口点。检查 Javadoc 如何针对 JDK 类和 Maven 依赖项进行解析;完成标准是两个弹窗都提供一个可打开相关 Javadoc 的浏览器操作,如果依赖项支持不可用,仅支持 JDK 也可以接受。

由索引模型根据 Issue 内容生成。

评估

技术栈
java, vscode
领域
developer-experience, documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
50/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。