redhat-developer / redhat-developer/vscode-java
Javadocs not displaying on hover
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 2.3k
- フォーク
- 546
- 平均マージ
- 20時間 1分
- マージ済み PR(30日)
- 11
説明
Hello, I have encountered an issue with displaying Javadocs on hover. I have narrowed down the problem to a single dependency that breaks the hover functionality for some classes/methods.
Environment
- Operating System: Puppy Linux F96-CE
- JDK version: IBM Semeru Runtime Open Edition 21.0.1.0 (build 21.0.1+12-LTS)
- Visual Studio Code version: 1.87.2
- Java extension version: 1.28.1
Steps To Reproduce
- [step 1] Open attached sample project
- [step 2] Hover on Spring annotations or
DiscordJarinprivate static final DiscordJar api
[Please attach a sample project reproducing the error]
sample-project.zip
client.log.2024-03-20.txt
log.txt
Current Result
Javadocs don't appear on hover
Expected Result
Javadocs appear on hover
Additional Informations
A lone direct dependency on spring-boot results in javadocs displaying for Spring annotations.
A direct dependency on spring-boot + dependency on discord.jar results in javadocs not displaying for Spring annotations nor discord.jar types.
A lone dependency on discord.jar results in javadocs not displaying for its own types (ex. DiscordJar) but they are present when viewed via Go to Definition or viewing some methods in code completion.
Using any transitive dependencies from discord.jar has their javadocs not appear (ex. Gson).
Signature help does display the javadocs as well, but not all of them (Spring annotations still don't show).
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
添付された sample-project.zip から始め、Spring アノテーションと DiscordJar でのホバー動作を再現してください。issue に記載されている依存関係の組み合わせと併せて client.log.2024-03-20.txt と log.txt を読み、対象となる Spring、DiscordJar、および推移的依存関係の型に対して、ホバー時に Javadocs が表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, vscode
- 領域
- developer-experience, tooling
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100