microsoft / microsoft/TypeScript
Allow reporting errors for unresolved @ link jsdoc tags
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Suggestion
🔍 Search Terms
- jsdoc
@link
⭐ Suggestion
Add an option to report unresolved @link symbols in JSDoc comments.
This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol
📃 Motivating Example
/**
* {@link food} <- Should been an error here
*/
const foo = 12
💻 Use Cases
We'd use this in vscode for both our main codebase and for our vscode.d.ts file.
I imagine this would also be quite useful for maintaining definitely typed
Related issues
- #15852
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 ejemplo motivador de JSDoc y el issue relacionado #15852 para determinar cómo deben diagnosticarse y hacerse configurables los símbolos @link no resueltos. El trabajo estará completo cuando una opción informe de los enlaces no resueltos sin afectar a los enlaces válidos, incluidos los casos de uso descritos para VS Code y los archivos de declaración.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- 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