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
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.3k
- Fork
- 546
- Merge medio
- 20h 1m
- PR unite (30g)
- 11
Descrizione
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
- Generate a java doc for a method
- Add a new argument to the method
Current Result
An outdated javadoc
Expected Result
- Show a warring
- Execute a code action to update the javadoc
- An updated javadoc
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non sono identificati file, test o punti di ingresso. Riproduci innanzitutto la discrepanza con JDK 17, VS Code 0.29.0 e Java extension 1.93.1, quindi individua i punti di ingresso della diagnostica e della code action dell'extension. Il lavoro è completato quando una discrepanza nella firma produce un avviso e un'azione che aggiorna il Javadoc.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, typescript, vscode
- Ambito
- developer-experience, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100