microsoft / microsoft/TypeScript
Allow type parameters instead of @template tags in JSDoc
Aperta
Nessuno ha ancora preso questa issue.
Domain: JSDoc
Experience Enhancement
In Discussion
Suggestion
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Rather than
/**
* @typedef Arrayify
* @type {{ [K in keyof T]: T[K][] }}
* @template T
*/
/**
* @typedef Bar
* @type {{ x: string, y: number }}
*/
/**
* @type {Arrayify<Bar>}
*/
var x;
I hate writing out the @template tag. Can we just write it out like this?
/**
* @typedef Arrayify<T>
* @type {{ [K in keyof T]: T[K][] }}
*/
/**
* @typedef Bar
* @type {{ x: string, y: number }}
*/
/**
* @type {Arrayify<Bar>}
*/
var x;
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
Non vengono indicati file, test o punti di ingresso. Inizia individuando la gestione JSDoc di @template e @typedef, quindi segui come i parametri generici sono rappresentati e utilizzati nell'esempio Arrayify. Il lavoro è completato quando la sintassi proposta per i parametri di tipo funziona senza @template e il comportamento JSDoc esistente rimane intatto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 32/100