microsoft / microsoft/TypeScript

Hover documentation for typescript uses jsdoc rules and not tsdoc

Abierto
#61,603 8 comentarios 5 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

  • VS Code Version: 1.99.3
    17baf841131aa23349f217ca7c570c76ee87b957
    x64
  • OS Version: N/A (happens on all)

Steps to Reproduce:

  1. Write some typescript code and use the syntax required by tsdoc
  2. Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
  3. Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support

Examples:

Thinking that the mandatory hyphen after a parameter name is a markdown hint for a bullet point
Image

Not recognizing the @defaultValue tag, and assuming @default and @defaultvalue

Image

Not understanding @remarks, which is marked as core, meaning you are expected to recognize it

Not providing hover for @typeParam
 Image

(The list goes on...)

Also, this last remark isn't a bug, but it would be really, really great if you would support @inheritDoc for hover.

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

Comienza reproduciendo los ejemplos de TSDoc listados en VS Code 1.99.3, comparando el texto del hover y el resaltado con las reglas de TSDoc enlazadas. Sigue la ruta de documentación del hover de TypeScript que gestiona las etiquetas JSDoc y, después, verifica que las etiquetas principales, como @param, @defaultValue, @remarks y @typeParam, se reconozcan con el formato esperado.

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
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.