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
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 2.3k
- Forks
- 546
- Merge moyen
- 20 h 1 min
- PR mergées (30 j)
- 11
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier, test ou point d’entrée n’est identifié. Reproduisez d’abord le mismatch avec JDK 17, VS Code 0.29.0 et Java extension 1.93.1, puis localisez les points d’entrée du diagnostic et de la code action de l’extension. C’est terminé lorsqu’un mismatch de signature produit un avertissement et une action qui met à jour la Javadoc.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java, typescript, vscode
- Domaine
- developer-experience, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100