microsoft / microsoft/TypeScript

Intellisense should inherit documentation for Interfaces.

Abierto
#29,516 4 comentarios 5 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Experience Enhancement Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.

Below is a picture of an example:

image

You can see that the description is properly shown however the param and returns tag is not.
What is expected:

image

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza reproduciendo el comportamiento de IntelliSense informado con una interfaz que contenga documentación y etiquetas @param/@returns; después, inspecciona la ruta del servicio de lenguaje de TypeScript que proporciona la documentación para los miembros de interfaz implementados. Se considera terminado cuando el miembro implementador muestra la descripción de la interfaz junto con las etiquetas de parámetros y retorno heredadas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
developer-experience
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.