microsoft / microsoft/TypeScript
JSDoc tags not parsed when a type may be present
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
### 🔎 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
https://www.typescriptlang.org/play/?#code/MYGwhgzhAEDC0G8BQBfJB6AVJp1PQAEAXACwCcB7AdxgQJAEsA7AazjT3SQDMBXJ4EQYUm0LJnSxYACgCUiVEA
### 💻 Code
```ts
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le lien TypeScript Playground fourni et l’exemple JSDoc contenant `@throws {@link C}`. Suivez l’analyse des balises JSDoc lorsqu’un type peut être présent ; le travail est terminé lorsque le lien est résolu vers `C` et que l’infobulle de Playground affiche le contenu du lien au lieu de séparer `@link` de `C`.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100