microsoft / microsoft/TypeScript
Support parsing TSDoc string comments
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Hi there!
I had a issue trip around Github and finally ended up here :)
Last issue was: https://github.com/microsoft/vscode/issues/95408
I am using String Literal types to define classnames and would love to populate with some more information.
So basically:
type TClassnames =
/** Some docs about red-500 */
| 'bg-color-red-500'
/** Some docs about red-600 */
| 'bg-color-red-600'
I would expect it to populate the docs on the right side of the intellisense:
This is how we can document with properties:

Which would be amazing to have on string literals.
I thought it was a TSDoc issue, but given this context: https://github.com/microsoft/tsdoc/issues/164, it seems to be VSCode not parsing it... though then it seems to actually be Typescript related?
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
L'issue non indica file o test; inizia tracciando i dettagli di completion del language-service di TypeScript per gli string-literal union members e confrontali con il comportamento esistente di property documentation. Il lavoro è completato quando i commenti TSDoc associati a singoli string literals compaiono in IntelliSense, con una coverage per il union pattern mostrato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100