Skip to content

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

Open

Description

@ImadABID

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

Activity

  1. changed the title [-]Feature suggestion: Show warrning when javadoc doesn't match the method signature and offer a code action to update it[/-] [+]Feature suggestion: Show warning when javadoc doesn't match the method signature and offer a code action to update it[/+] on Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions