microsoft / microsoft/TypeScript

JSDoc tags not parsed when a type may be present

Aperta
#62,244 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Bug Domain: JSDoc Help Wanted
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

🔎 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
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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con il link fornito a TypeScript Playground e con l’esempio JSDoc contenente @throws {@link C}. Traccia il modo in cui vengono analizzati i tag JSDoc quando può essere presente un tipo; il lavoro è completato quando il link viene risolto in C e l’hover di Playground mostra il contenuto del link invece di separare @link da C.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.