microsoft / microsoft/TypeScript
JSDoc comment for destructuring param: description text not displayed
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
TypeScript Version:
2.9
Search Terms:
JSDoc destructuring param
Code
/**
* @param {Object} arg
* @param {number} arg.id - This param description won't show up
*/
function foo({ id }) {}
Expected behavior:
In VSCode 1.24.0, when typing foo(, IntelliSense should display the full param description, including its type and text.
Actual behavior:
The type is displayed ("number"), but not the text ("This param description won't show up"):
Related Issues:
https://github.com/Microsoft/TypeScript/issues/19645
Additional remark
When omitting the {Object} line, the param text shows up correctly:
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 el ejemplo con TypeScript 2.9 en VSCode 1.24.0 y compáralo con el caso que omite la línea {Object}. Lee el issue relacionado #19645 para obtener contexto. Se considera terminado cuando IntelliSense para foo( muestra el tipo y el texto de descripción del parámetro desestructurado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- devtools
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 35/100