microsoft / microsoft/TypeScript
Hover documentation for typescript uses jsdoc rules and not tsdoc
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
- VS Code Version: 1.99.3
17baf841131aa23349f217ca7c570c76ee87b957
x64 - OS Version: N/A (happens on all)
Steps to Reproduce:
- Write some typescript code and use the syntax required by tsdoc
- Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
- Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support
Examples:
Thinking that the mandatory hyphen after a parameter name is a markdown hint for a bullet point
Not recognizing the @defaultValue tag, and assuming @default and @defaultvalue
Not understanding @remarks, which is marked as core, meaning you are expected to recognize it
Not providing hover for @typeParam
(The list goes on...)
Also, this last remark isn't a bug, but it would be really, really great if you would support @inheritDoc for hover.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia riproducendo gli esempi TSDoc elencati in VS Code 1.99.3, confrontando il testo dell'hover e l'evidenziazione con le regole TSDoc collegate. Segui il percorso della documentazione hover di TypeScript che gestisce i tag JSDoc, quindi verifica che i tag principali come @param, @defaultValue, @remarks e @typeParam vengano riconosciuti con la formattazione prevista.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100