microsoft / microsoft/TypeScript

Support parsing TSDoc string comments

Abierto
#38,106 12 comentarios 149 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Hi there!

I had a issue trip around Github and finally ended up here :)

Last issue was: https://github.com/microsoft/vscode/issues/95408

I am using String Literal types to define classnames and would love to populate with some more information.

So basically:

type TClassnames = 
   /** Some docs about red-500 */
    | 'bg-color-red-500'
   /** Some docs about red-600 */
    | 'bg-color-red-600'

I would expect it to populate the docs on the right side of the intellisense:

Screenshot 2020-02-12 at 07 31 36

This is how we can document with properties:

Screenshot 2020-02-12 at 10 10 59

Which would be amazing to have on string literals.

I thought it was a TSDoc issue, but given this context: https://github.com/microsoft/tsdoc/issues/164, it seems to be VSCode not parsing it... though then it seems to actually be Typescript related?

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

El issue no nombra archivos ni tests; empieza rastreando los detalles de completion del language-service de TypeScript para los string-literal union members y compáralos con el comportamiento existente de property documentation. Se considera terminado cuando los comentarios TSDoc adjuntos a string literals individuales aparecen en IntelliSense, con cobertura para el union pattern demostrado.

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
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 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.