redhat-developer / redhat-developer/vscode-java

Javadoc support for referencedLibraries?

未关闭
#2,984 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

If a non-maven/gradle library is added to referencedLibraries config (added by https://github.com/redhat-developer/vscode-java/pull/1196) - it is impossible to add the library's javadoc.

Environment
  • Operating System: Tried OSX and Gentoo Linux.
  • JDK version: 19
  • Visual Studio Code version: 1.76.0
  • Java extension version: v0.25.8
Steps To Reproduce
  1. Download any library from maven, e.g. https://repo1.maven.org/maven2/com/pelzer/util/pelzer-util/1.9.0/pelzer-util-1.9.0.jar and https://repo1.maven.org/maven2/com/pelzer/util/pelzer-util/1.9.0/pelzer-util-1.9.0-javadoc.jar
  2. Delete META-INF/maven from the jar
  3. Add two jars as referenced libraries to settings.json
  4. Import a class and hover over it or ctrl+click on it. Only bare decompiler structure shows up without documentation.
Current Result

Import a class and hover over it or ctrl+click on it. Only bare decompiler structure shows up without documentation.

Expected Result

Ability to map javadoc jars to libraries to allow for javadoc presentation on hover.

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 referencedLibraries 配置开始,在移除 META-INF/maven 后导入一个类并使用 hover 或 Ctrl+click,以复现缺失的文档。当用户可以将 Javadoc JAR 映射到一个被引用的库,并在 hover 时看到其文档时,即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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