search

redhat-developer / vscode-java

Java Language Support for Visual Studio Code
Eclipse Public License 2.0
2.08k stars 440 forks source link

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

Open ImadABID opened 2 months ago

ImadABID commented 2 months ago

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
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