microsoft / microsoft/TypeScript
Hover documentation for typescript uses jsdoc rules and not tsdoc
Nadie ha tomado este issue todavía.
- 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:
- Write some typescript code and use the syntax required by tsdoc
- Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
- 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
Not recognizing the @defaultValue tag, and assuming @default and @defaultvalue
Not understanding @remarks, which is marked as core, meaning you are expected to recognize it
Not providing hover for @typeParam
(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
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 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