microsoft / microsoft/TypeScript
JSDoc tags not parsed when a type may be present
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
🔎 Search Terms
jsdoc links missing in possible type position
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about JSDoc
⏯ Playground Link
💻 Code
class C {
}
/**
* @throws {@link C}
*/
function /**/CC() {
}
🙁 Actual behavior
TypeScript does not resolve {@link C}.
Hover on the playground shows:
@throws — {
@link — C}
🙂 Expected behavior
TypeScript should resolve {@link C}
Hover on the playground should show this (or even better rendered links like it does in vscode)
@throws — {@link C }
Additional information about the issue
Originally reported in https://github.com/TypeStrong/typedoc/issues/2993
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 con el enlace proporcionado de TypeScript Playground y el ejemplo de JSDoc que contiene @throws {@link C}. Sigue cómo se analizan las etiquetas JSDoc cuando puede haber un tipo; se considera terminado cuando el enlace se resuelve a C y el hover de Playground muestra el contenido del enlace en lugar de separar @link de C.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100