Skip to content

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

@ImadABID

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions