redhat-developer / redhat-developer/vscode-java
Include Return Type Annotations in Method Hover Tooltip
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.3k
- Fork
- 546
- Merge medio
- 20h 1m
- PR unite (30g)
- 11
Descrizione
Description
When hovering over a method in the editor, the tooltip currently shows the method signature and Javadoc (if available). However, annotations applied to the method’s return type are not displayed.
This feature request proposes enhancing the hover tooltip to include annotations declared on the return type.
Example
public @Nullable String getName() {
return name;
}
or with type-use annotations:
public List<@NonNull String> getNames() {
return names;
}
Current Behavior:
Hover tooltip shows:
String getName()
Expected Behavior:
Hover tooltip shows:
@Nullable String getName()
and for generics:
List<@NonNull String> getNames()
Motivation / Use Case
Return type annotations (e.g., nullability annotations like @Nullable, @NonNull, or custom type-use annotations) are critical for understanding API contracts, static analysis, and preventing runtime errors.
Not displaying them in hover:
- Hides important semantic information
- Forces developers to navigate to the declaration
- Reduces the usefulness of hover as a quick inspection tool
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando l’implementazione Java del tooltip al passaggio del mouse nell’estensione VS Code e tracciando il modo in cui vengono visualizzate le firme dei metodi. Usa gli esempi @Nullable e List<@NonNull String> come casi attesi; il lavoro è completato quando nella visualizzazione al passaggio del mouse compaiono sia le annotazioni di ritorno della dichiarazione sia quelle di uso del tipo, e sono stati aggiunti o aggiornati i test corrispondenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, typescript, vscode
- Ambito
- developer-experience, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 52/100