redhat-developer / redhat-developer/vscode-java

Import that is used in @code or @link in JavaDoc is marked as unused

オープン
#2,035 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

diagnostics
主要言語
TypeScript
スター
2.3k
フォーク
546
平均マージ
20時間 1分
マージ済み PR(30日)
11

説明

Imports that are only used in @code or @link of JavaDoc are marked as unused and Organize imports will remove them.

Environment
  • Operating System: 20.04.2 LTS (Focal Fossa)
  • JDK version: openjdk 11.0.6 2020-01-14
  • Visual Studio Code version: 1.58.2
  • Java extension version: v.0.81.0
Steps To Reproduce
  1. Check out https://github.com/fvclaus/vscode-java-javadoc-link-bug and open App.java
  2. Run Organize imports
import java.util.HashSet;

/**
 * Uses {@code HashSet#clear()}
 *
 */

vscode_javadoc

Current Result

Import is marked as unused and will be removed with Organize imports.

Expected Result

Import is not marked as unused and will not be removed with Organize imports.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Issue にリンクされている App.java の再現コードから始め、Organize imports を実行して {@code} 内の HashSet 参照がどのように扱われるかを確認します。その動作を起点に、未使用 import の分析と JavaDoc 参照の処理を追跡します。JavaDoc でのみ使用される import が Organize imports によって未使用としてマークされたり削除されたりしなければ完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, vscode
領域
tooling
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。