redhat-developer / redhat-developer/vscode-java
Include Return Type Annotations in Method Hover Tooltip
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 2.3k
- Forks
- 546
- Merge medio
- 20 h 1 min
- PR fusionados (30 d)
- 11
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza por localizar la implementación de Java del tooltip de hover en la extensión de VS Code y rastrear cómo se representan las firmas de los métodos. Usa los ejemplos @Nullable y List<@NonNull String> como casos esperados; la tarea estará terminada cuando tanto las anotaciones de retorno de declaración como las de uso de tipo aparezcan en la salida del hover, y se hayan añadido o actualizado las pruebas correspondientes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, typescript, vscode
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 52/100