Javadoc overriding methods not inheriting @param descriptions

Offen

#962 erstellt am 23.6.2019 6 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java, typescript
Bereich: developer-experience, tooling

Rechercherichtung

Beginne damit, das Hover-Verhalten mit den Java-Dateien Foo und Bar aus dem Issue zu reproduzieren, und vergleiche dann den Javadoc-Text der überschriebenen Methode mit der HTML-Ausgabe des Javadoc-Tools. Das Issue ist abgeschlossen, wenn die geerbte @param-Beschreibung für i im Hover-Popup erscheint und mit der übergeordneten Methode sowie dem dokumentierten Javadoc-Verhalten übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug hover javadoc

EDIT: This issue was originally about the {@inheritDoc} tag, but I realized it's actually caused by something else after some more experimentation.

~~When method Javadocs are inherited through {@inheritDoc}, the parameter descriptions are not shown in the hover popups.~~

When hovering over methods that override a parent method, the descriptions for @param tags in the parent's Javadoc are not inherited, which does not match the Javadoc tool's HTML output.

Environment

Operating System: Ubuntu 18.04/20.04
JDK version: 11.0.3
Visual Studio Code version: 1.36.0-insider/1.56.0-insider
Java extension version: 0.46.0/0.77.0

Steps To Reproduce

Open a new folder
Create two Java files:

public class Foo {
    /**
     * Foo.foo
     * 
     * @param i an int
     */
    public int foo(int i) {
        return i;
    }
}

public class Bar extends Foo {
    @Override
    public int foo(int i) {
        return i;
    }
}

Hover over the foo method name in Bar to see the Javadoc.

Current Result

When hovering above Bar.foo(int), in the Javadoc popup, the description for the parameter i is empty:

Expected Result

The description for i should be the same as in Foo.foo(int), which is what the Javadoc tool does:

According to the documentation of the Javadoc tool, the missing @param tags should have been inherited from the overridden method. This does work for @return and @throws tags, but not for @param tags.

Vorherrschende Sprache: TypeScript
Sterne: 2.3k
Forks: 547
Ø Merge: 20 Std. 1 Min.
Gemergte PRs (30 T.): 11

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus redhat-developer/vscode-java

JDK_HOME can be sorted after lower-priority auto-detected JDK sources Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

redhat-developer/vscode-java#4426 · Erstellt am 15.6.2026
Language Support for Java [1.56.0] - Out of memory error Offen

bug

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

redhat-developer/vscode-java#4506 · 3 Kommentare · 4 Reaktionen · Erstellt am 11.9.2026
Language Support for Java fails to initialize: command 'sts.java.addClasspathListener' already exists Offen

bug

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

redhat-developer/vscode-java#4505 · 1 Kommentar · 1 Reaktion · Erstellt am 10.9.2026
Bundled Lombok crashes JDT indexing in 1.57.2026090508: ConstructorDeclaration.constructorCall NoSuchFieldError Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100

redhat-developer/vscode-java#4504 · 3 Kommentare · 1 Reaktion · Erstellt am 09.9.2026
Stale “Build Failed” state after successful Maven build and Run Offen

bug

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 62/100

redhat-developer/vscode-java#4502 · Erstellt am 07.9.2026

Alle Issues in redhat-developer/vscode-java