redhat-developer / redhat-developer/vscode-java

Feature suggestion: Show warning when javadoc doesn't match the method signature and offer a code action to update it

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

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

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

説明

It’s difficult to remember to update the Javadoc of a method after modifying its signature. It would be practical if the extension could detect this mismatch, show a warning, and propose an update.

Environment
  • JDK version: 17
  • Visual Studio Code version: v0.29.0
  • Java extension version: 1.93.1
Steps To Reproduce
  1. Generate a java doc for a method
  2. Add a new argument to the method
Current Result

An outdated javadoc

Expected Result
  1. Show a warring
  2. Execute a code action to update the javadoc
  3. An updated javadoc

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

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

はじめの一歩

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

調査の方向性

ファイル、テスト、エントリポイントは特定されていません。まず JDK 17、VS Code 0.29.0、Java extension 1.93.1 で不一致を再現し、次に extension の diagnostic と code-action のエントリポイントを特定してください。シグネチャの不一致によって警告と Javadoc を更新するアクションが生成されれば完了です。

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

評価

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

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

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