microsoft / microsoft/TypeScript
JSDoc tags not parsed when a type may be present
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
### 🔎 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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem bereitgestellten TypeScript Playground-Link und dem JSDoc-Beispiel, das `@throws {@link C}` enthält. Verfolge, wie JSDoc-Tags geparst werden, wenn ein Typ vorhanden sein kann; fertig ist die Aufgabe, wenn der Link zu `C` aufgelöst wird und der Hover im Playground den Linkinhalt anzeigt, anstatt `@link` von `C` zu trennen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100